[build] update README.md and fix appveyor.yml
This commit is contained in:
parent
3d3feeef4c
commit
b69062f20a
25
README.md
25
README.md
|
|
@ -14,8 +14,33 @@ Kiwano-Core is a game irrelevant lib that provide a lot useful tools can be used
|
||||||
|
|
||||||
It's still under heavy developing. I write it and use it to developy my own tiny games.
|
It's still under heavy developing. I write it and use it to developy my own tiny games.
|
||||||
|
|
||||||
|
You can move to [Kiwano Demos](https://github.com/Nomango/KiwanoDemos) repository to see how to use Kiwano implement simple games.
|
||||||
|
|
||||||
More docs and examples will be added later.
|
More docs and examples will be added later.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
### Dev Environment
|
||||||
|
|
||||||
|
- Win8 or Greater (Win10 recommended)
|
||||||
|
- Visual Studio 2015 or Greater
|
||||||
|
|
||||||
|
### Install with NuGet
|
||||||
|
|
||||||
|
1. Open your Visual Studio solution
|
||||||
|
2. In Solution Explorer, right-click `References` and choose `Manage NuGet Packages`
|
||||||
|
3. Select the `Browse` tab, search for `kiwano`, select that package in the list, and select Install
|
||||||
|
4. Have a good trip with Kiwano !
|
||||||
|
|
||||||
|
### Install with source code
|
||||||
|
|
||||||
|
1. Clone or download source code from Github repository
|
||||||
|
2. Open your Visual Studio solution, right-click your solution in Solution Explorer, select `Add` and then `Existing item`
|
||||||
|
3. Select `.vcxproj` files in /projects folder which you downloaded in 1st step
|
||||||
|
4. Right-click your project and choose `Properties`, select C\C++ => General, add the root directory of kiwano project to the `Additional include directory` field
|
||||||
|
5. Right-click `References` and choose `Add Reference`, select `kiwano` project
|
||||||
|
6. Now you can build your own applications based on Kiwano source code !
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
* Scene management
|
* Scene management
|
||||||
* Transitions between scenes
|
* Transitions between scenes
|
||||||
|
|
|
||||||
|
|
@ -26,9 +26,9 @@ skip_commits:
|
||||||
|
|
||||||
only_commits:
|
only_commits:
|
||||||
files:
|
files:
|
||||||
- '**/*.(h|hpp|cpp)'
|
- /**\/*\.(h|hpp|cpp)/
|
||||||
- '**/*.(sln|vcxproj|rc)'
|
- /**\/*\.(sln|vcxproj|rc)/
|
||||||
- 'scripts/**/*.ps1'
|
- /scripts\/**\/*\.ps1/
|
||||||
- 'appveyor.yml'
|
- 'appveyor.yml'
|
||||||
|
|
||||||
for:
|
for:
|
||||||
|
|
@ -65,6 +65,8 @@ after_build:
|
||||||
artifacts:
|
artifacts:
|
||||||
- path: projects/output/**/*.lib
|
- path: projects/output/**/*.lib
|
||||||
name: $(appveyor_project_name)-v$(appveyor_build_version)-$(VS_PLATFORM_TOOLSET).$(platform).$(configuration)
|
name: $(appveyor_project_name)-v$(appveyor_build_version)-$(VS_PLATFORM_TOOLSET).$(platform).$(configuration)
|
||||||
|
- path: projects/output/**/*.pdb
|
||||||
|
name: $(appveyor_project_name)-v$(appveyor_build_version)-$(VS_PLATFORM_TOOLSET).$(platform).$(configuration)
|
||||||
|
|
||||||
before_deploy:
|
before_deploy:
|
||||||
- ps: .\scripts\appveyor\coapp_make.ps1
|
- ps: .\scripts\appveyor\coapp_make.ps1
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,25 @@
|
||||||
|
. .\scripts\appveyor\appveyor_get_build.ps1
|
||||||
|
. .\scripts\appveyor\appveyor_get_artifacts.ps1
|
||||||
|
|
||||||
|
# get job artifacts
|
||||||
|
Write-Host "Start to download artifacts from other jobs"
|
||||||
|
|
||||||
|
(Get-AppVeyorBuild).build.jobs | foreach-object {
|
||||||
|
$jobId = $_.jobId
|
||||||
|
if ($jobId -ne $env:APPVEYOR_JOB_ID) {
|
||||||
|
# Get job artifacts information
|
||||||
|
(Get-AppVeyorArtifacts -Job $jobId) | foreach-object {
|
||||||
|
# Create directory if not exists
|
||||||
|
$filePath = $_.fileName.Substring(0, $_.fileName.LastIndexOf('/'))
|
||||||
|
if (!(Test-Path -Path $filePath)) {
|
||||||
|
New-Item -ItemType "directory" -Path $filePath
|
||||||
|
}
|
||||||
|
# Download artifact from other job
|
||||||
|
Start-FileDownload "https://ci.appveyor.com/api/buildjobs/$jobId/artifacts/$($_.fileName)" -FileName $_.fileName
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
Write-Host "Start to build nupkg files"
|
Write-Host "Start to build nupkg files"
|
||||||
|
|
||||||
# This is the CoApp .autopkg file to create.
|
# This is the CoApp .autopkg file to create.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,4 @@
|
||||||
. .\scripts\appveyor\appveyor_get_build.ps1
|
. .\scripts\appveyor\appveyor_get_build.ps1
|
||||||
. .\scripts\appveyor\appveyor_get_artifacts.ps1
|
|
||||||
|
|
||||||
# Only deploy when commit message contains "[deploy]"
|
# Only deploy when commit message contains "[deploy]"
|
||||||
if (!(Get-AppVeyorBuild).build.message.Contains('[deploy]')) { return }
|
if (!(Get-AppVeyorBuild).build.message.Contains('[deploy]')) { return }
|
||||||
|
|
@ -28,22 +27,5 @@ if (!$success) {
|
||||||
throw "Test jobs were not finished in $env:time_out_mins minutes"
|
throw "Test jobs were not finished in $env:time_out_mins minutes"
|
||||||
}
|
}
|
||||||
|
|
||||||
# get job artifacts
|
|
||||||
(Get-AppVeyorBuild).build.jobs | foreach-object {
|
|
||||||
$jobId = $_.jobId
|
|
||||||
if ($jobId -ne $env:APPVEYOR_JOB_ID) {
|
|
||||||
# Get job artifacts information
|
|
||||||
(Get-AppVeyorArtifacts -Job $jobId) | foreach-object {
|
|
||||||
# Create directory if not exists
|
|
||||||
$filePath = $_.fileName.Substring(0, $_.fileName.LastIndexOf('/'))
|
|
||||||
if (!(Test-Path -Path $filePath)) {
|
|
||||||
New-Item -ItemType "directory" -Path $filePath
|
|
||||||
}
|
|
||||||
# Download artifact from other job
|
|
||||||
Start-FileDownload "https://ci.appveyor.com/api/buildjobs/$jobId/artifacts/$($_.fileName)" -FileName $_.fileName
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
# Set flag to deploy
|
# Set flag to deploy
|
||||||
$env:flag_to_deploy = $success
|
$env:flag_to_deploy = $success
|
||||||
|
|
@ -124,7 +124,7 @@ nuget {
|
||||||
lib += ${OUTPUT_DIR}v142\Win32\Release\*.lib;
|
lib += ${OUTPUT_DIR}v142\Win32\Release\*.lib;
|
||||||
}
|
}
|
||||||
|
|
||||||
# kiwano-network 3-rd patry
|
// kiwano-network 3-rd patry
|
||||||
bin += ${KIWANO_NETWORK_ROOT}dlls\*.dll;
|
bin += ${KIWANO_NETWORK_ROOT}dlls\*.dll;
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue