From 5ccbf5d6e66f7ca0850d12fcf80e16efd1cd532f Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Fri, 8 Nov 2024 12:25:08 +0100 Subject: fix sdl_ttf submodule --- .gitmodules | 4 ++++ 1 file changed, 4 insertions(+) (limited to '.gitmodules') diff --git a/.gitmodules b/.gitmodules index 481519b..c8571bc 100644 --- a/.gitmodules +++ b/.gitmodules @@ -14,3 +14,7 @@ path = lib/sdl_image url = https://github.com/libsdl-org/SDL_image shallow = true +[submodule "lib/sdl_ttf"] + path = lib/sdl_ttf + url = https://github.com/libsdl-org/SDL_ttf.git + shallow = true -- cgit v1.2.3 From 0feda3d123ff99a1b9e41837482268bebfd9140a Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Fri, 8 Nov 2024 12:48:25 +0100 Subject: update libraries --- .gitmodules | 4 ++++ lib/libdb | 1 + lib/sdl_image | 2 +- lib/sdl_ttf | 2 +- lib/soloud | 2 +- readme.md | 39 ++++++++++++++++++++++++++++++--------- 6 files changed, 38 insertions(+), 12 deletions(-) create mode 160000 lib/libdb (limited to '.gitmodules') 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 index 0000000..5b7b02a --- /dev/null +++ b/lib/libdb @@ -0,0 +1 @@ +Subproject commit 5b7b02ae052442626af54c176335b67ecc613a30 diff --git a/lib/sdl_image b/lib/sdl_image index c6c7278..abcf63a 160000 --- a/lib/sdl_image +++ b/lib/sdl_image @@ -1 +1 @@ -Subproject commit c6c7278b86b5de1232b10de8f612ed05cf2d11f6 +Subproject commit abcf63aa71b4e3ac32120fa9870a6500ddcdcc89 diff --git a/lib/sdl_ttf b/lib/sdl_ttf index a3d0895..4a318f8 160000 --- a/lib/sdl_ttf +++ b/lib/sdl_ttf @@ -1 +1 @@ -Subproject commit a3d0895c1b60c41ff9e85d9203ddd7485c014dae +Subproject commit 4a318f8dfaa1bb6f10e0c5e54052e25d3c7f3440 diff --git a/lib/soloud b/lib/soloud index e82fd32..c8e339f 160000 --- a/lib/soloud +++ b/lib/soloud @@ -1 +1 @@ -Subproject commit e82fd32c1f62183922f08c14c814a02b58db1873 +Subproject commit c8e339fdce5c7107bdb3e64bbf707c8fd3449beb diff --git a/readme.md b/readme.md index 7cf044f..f699c27 100644 --- a/readme.md +++ b/readme.md @@ -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). - -- cgit v1.2.3