You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ If you do not want to use this directory then you can modify which files are col
16
16
17
17
A workflow exists at [.github/workflows/cmake.yml](.github/workflows/cmake.yml) which automatically compiles the program for Windows, macOS, and Ubuntu Linux.
18
18
The workflow simply invokes CMake directly, since this setup does not depend on a specific IDE to work.
19
+
Actions which pass without fail will provide archived executables to test with, these are temporary and are downloaded from the passing action under *automated-builds*.
20
+
To permanently publish these builds you can push an annotated tag named after the version of the build, such as `1.0.0` or `2000.12.30`.
19
21
20
22
## How to setup
21
23
@@ -24,7 +26,7 @@ The workflow simply invokes CMake directly, since this setup does not depend on
24
26
Make sure you install the C++ compiler tools from [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/),
25
27
install the latest [CMake](https://cmake.org/download/),
26
28
and install [Visual Studio Code](https://code.visualstudio.com/download).
27
-
*[Create a new repository from ths template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template#creating-a-repository-from-a-template). **You do not use the GitHub fork button unless you're contributing to this template.**
29
+
*[Create a new repository from ths template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template#creating-a-repository-from-a-template). **You do not use the GitHub fork button unless you're contributing.**
28
30
*[Clone your new repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository).
29
31
* Make sure to initialize the `vcpkg` and `libtcod`[submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). If either folder is empty then the build process will fail.
30
32
* The command to do this is: `git submodule update --init --recursive`
@@ -41,7 +43,7 @@ Now that you know the template works you'll want to take care the following:
41
43
* Replace the license in [LICENSE.txt](LICENSE.txt) with your own, see [choosealicense.com](https://choosealicense.com/).
42
44
* Modify [vcpkg.json](vcpkg.json) to include any libraries [from Vcpkg](https://vcpkg.info/) that you want to use such as the popular [fmt](https://fmt.dev/latest/index.html) library.
43
45
You'll need to add these libraries to [CMakeLists.txt](CMakeLists.txt) to link them.
44
-
* Change `libtcod-vcpkg-template` in [CMakeLists.txt](CMakeLists.txt) to the name of your game.
46
+
* Change `libtcod-vcpkg-template` in [CMakeLists.txt](CMakeLists.txt)and [.github/workflows/cmake.yml](.github/workflows/cmake.yml)to the name of your game.
45
47
You may want to edit other parts of the CMake script as well, such as the included source files.
46
48
* Verify the style settings in [.clang-format](.clang-format) and [.editorconfig](.editorconfig).
0 commit comments