speed-dreams/speed-dreams-code
6
0
Fork 1
Code Issues 8 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Merge pull request 'README.md: Fix invalid links' (#20) from fix-readme-2 into main

Browse source 
Reviewed-on: #20
This commit is contained in:
Xavier Del Campo Romero 2025-01-15 07:44:40 +01:00
commit ac052b58d0
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -8,7 +8,7 @@ it has evolved into a higher level of maturity, featuring realistic physics
with tens of high-quality cars and tracks to choose from. with tens of high-quality cars and tracks to choose from.
> **This repository contains the engine source code,** > **This repository contains the engine source code,**
> **and the base assets [as a submodule](/speed-dreams-data/).** > **and the base assets [as a submodule](./speed-dreams-data/).**
> **End users are expected to download the pre-built packages listed below.** > **End users are expected to download the pre-built packages listed below.**
> >
> The assets repository is located on > The assets repository is located on
@ -27,7 +27,7 @@ Speed Dreams binaries are available for the following platforms:
In-tree builds (i.e., including both code and data on the same build) In-tree builds (i.e., including both code and data on the same build)
are recommended for simplicity. To achieve this, update the are recommended for simplicity. To achieve this, update the
[`speed-dreams-data/`](/speed-dreams-data/) submodule with: [`speed-dreams-data/`](./speed-dreams-data/) submodule with:
``` ```
git submodule update --init --recursive git submodule update --init --recursive
@ -77,13 +77,13 @@ cmake -B build
On Windows, dependencies cannot be fetched from a package manager as in On Windows, dependencies cannot be fetched from a package manager as in
conventional Linux distributions. To solve this, Speed Dreams defines conventional Linux distributions. To solve this, Speed Dreams defines
[a separate build system for third-party dependencies](/packaging/3rdParty-devel/). [a separate build system for third-party dependencies](./packaging/3rdParty-devel/).
This would build all dependencies from source, so they can be later found This would build all dependencies from source, so they can be later found
by CMake. by CMake.
> **Both methods described below will require the path to the pre-built** > **Both methods described below will require the path to the pre-built**
> **dependencies**. > **dependencies**.
> Please read [the instructions](/packaging/3rdParty-devel/README.md) > Please read [the instructions](./packaging/3rdParty-devel/README.md)
> for further reference. > for further reference.
#### Native builds #### Native builds
@ -112,9 +112,9 @@ system like GNU/Linux. The
[`w64-mingw32`](https://git.code.sf.net/p/mingw-w64/mingw-w64) [`w64-mingw32`](https://git.code.sf.net/p/mingw-w64/mingw-w64)
toolchain can be used for the cross-compilation, with dedicated toolchain can be used for the cross-compilation, with dedicated
toolchain files for toolchain files for
[`i686-w64-mingw32`](/packaging/3rdParty-devel/i686-w64-mingw32.cmake) [`i686-w64-mingw32`](./packaging/3rdParty-devel/i686-w64-mingw32.cmake)
and and
[`x86_64-w64-mingw32`](/packaging/3rdParty-devel/x86_64-w64-mingw32.cmake), [`x86_64-w64-mingw32`](./packaging/3rdParty-devel/x86_64-w64-mingw32.cmake),
referred to by the referred to by the
[`CMAKE_TOOLCHAIN_FILE`](https://cmake.org/cmake/help/latest/variable/CMAKE_TOOLCHAIN_FILE.html) [`CMAKE_TOOLCHAIN_FILE`](https://cmake.org/cmake/help/latest/variable/CMAKE_TOOLCHAIN_FILE.html)
variable. Third-party dependencies are then referred to by the variable. Third-party dependencies are then referred to by the

6
packaging/3rdParty-devel/README.md
View file

@ -13,10 +13,10 @@ pinnings against third-party dependencies. A build consists of:
2. Building the dependencies. 2. Building the dependencies.
3. Installing them to the `3rdParty/` directory, inside the build directory. 3. Installing them to the `3rdParty/` directory, inside the build directory.
**This is the directory referred to by the top-level** **This is the directory referred to by the top-level**
**[`CMakeLists.txt`](/CMakeLists.txt)** **[`CMakeLists.txt`](../../CMakeLists.txt)**
**when performing Windows builds, via either `CMAKE_PREFIX_PATH` or** **when performing Windows builds, via either `CMAKE_PREFIX_PATH` or**
**`CMAKE_FIND_ROOT_PATH`**. Read **`CMAKE_FIND_ROOT_PATH`**. Read
[the relevant section from the top-level `README.md`](/README.md#windows) [the relevant section from the top-level `README.md`](../../README.md#windows)
for further reference. for further reference.
## Requirements ## Requirements
@ -94,4 +94,4 @@ cmake --build build/ # Optionally, add -j8 or any other number for faster builds
The build will probably take a long time, as it builds tens of third-party The build will probably take a long time, as it builds tens of third-party
libraries fetched from multiple sources. Once finished, a directory called libraries fetched from multiple sources. Once finished, a directory called
`3rdParty/` should be available inside the build directory, ready to be `3rdParty/` should be available inside the build directory, ready to be
consumed by [the top-level `CMakeLists.txt`](/CMakeLists.txt). consumed by [the top-level `CMakeLists.txt`](../../CMakeLists.txt).