diff options
| -rw-r--r-- | .gitmodules | 4 | ||||
| m--------- | lib/libdb | 0 | ||||
| m--------- | lib/sdl_image | 0 | ||||
| m--------- | lib/sdl_ttf | 0 | ||||
| m--------- | lib/soloud | 0 | ||||
| -rw-r--r-- | readme.md | 39 |
6 files changed, 34 insertions, 9 deletions
diff --git a/.gitmodules b/.gitmodules index c8571bc..2f64601 100644 --- a/.gitmodules +++ b/.gitmodules @@ -18,3 +18,7 @@ path = lib/sdl_ttf url = https://github.com/libsdl-org/SDL_ttf.git shallow = true +[submodule "lib/libdb"] + path = lib/libdb + url = https://github.com/berkeleydb/libdb + shallow = true diff --git a/lib/libdb b/lib/libdb new file mode 160000 +Subproject 5b7b02ae052442626af54c176335b67ecc613a3 diff --git a/lib/sdl_image b/lib/sdl_image -Subproject c6c7278b86b5de1232b10de8f612ed05cf2d11f +Subproject abcf63aa71b4e3ac32120fa9870a6500ddcdcc8 diff --git a/lib/sdl_ttf b/lib/sdl_ttf -Subproject a3d0895c1b60c41ff9e85d9203ddd7485c014da +Subproject 4a318f8dfaa1bb6f10e0c5e54052e25d3c7f344 diff --git a/lib/soloud b/lib/soloud -Subproject e82fd32c1f62183922f08c14c814a02b58db187 +Subproject c8e339fdce5c7107bdb3e64bbf707c8fd3449be @@ -16,12 +16,32 @@ This repository uses CMake (the makefile in the root of this repository is for running auxiliary tasks only). See [src/readme.md](src/readme.md) for detailed building instructions. -## Installing libraries +## Code style + +Please read [contributing.md](./contributing.md). + +## Libraries + +This project uses the following libraries + +|Name|Version| +|-|-:| +|`SDL2`|2.30.9| +|`SDL2_image`|2.8.2| +|`SDL_ttf`|2.22.0| +|`SoLoud`|20200207| +|Google Test (`GTest`)|1.15.2| +|Berkeley DB (`libdb`)|5.3.21| + +> [!NOTE] +> Most of these libraries are likely available from your package manager if you +> are using Linux or MinGW. Make sure your entire distribution is up-to-date if +> you are not using a rolling release distribution. -The expected library (source) versions are included in this repository as git -submodules, which may be used if your distro's package manager does not provide -(recent enough versions of) them. To build any of the dependencies, make sure -the submodules are initialized by running: +The sources for all of the above libraries are also included in this repository +as git submodules, which may be used if your distro's package manager does not +provide (recent enough versions of) them. To build any of the libraries +manually, make sure the submodules are initialized by running: ``` $ git submodule update --init --recursive --depth 1 @@ -35,6 +55,7 @@ Then, follow these steps for each library you want to install: $ cd lib/sdl2 $ cd lib/soloud/contrib $ cd lib/sdl_image + $ cd lib/sdl_ttf ``` 2. Use CMake to configure the build, run the build and install (run **all** of these): @@ -44,6 +65,10 @@ Then, follow these steps for each library you want to install: # cmake --install build ``` +## Tooling + +- TODO + ## Documentation API documentation is done using Doxygen. To generate the docs, run @@ -51,7 +76,3 @@ API documentation is done using Doxygen. To generate the docs, run $ make doxygen ``` -## Code style - -Please read [contributing.md](./contributing.md). - |