Merge pull request 'README.md
: Minor changes' (#19) from fix-readme into main
Reviewed-on: #19
This commit is contained in:
commit
5e7335fe99
2 changed files with 5 additions and 3 deletions
|
@ -1,12 +1,14 @@
|
||||||
# Speed Dreams
|
# Speed Dreams
|
||||||
|
|
||||||
|
![Speed Dreams logo](./doc/readme/sd-logo.png)
|
||||||
|
|
||||||
Speed Dreams is a free and open source motorsport simulator. Originally
|
Speed Dreams is a free and open source motorsport simulator. Originally
|
||||||
a fork of the [TORCS](https://torcs.sourceforge.net/) project,
|
a fork of the [TORCS](https://torcs.sourceforge.net/) project,
|
||||||
it has evolved into a higher level of maturity, featuring realistic physics
|
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](/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
|
||||||
|
@ -24,8 +26,8 @@ Speed Dreams binaries are available for the following platforms:
|
||||||
## Building from source
|
## Building from source
|
||||||
|
|
||||||
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 [`data/`](/data/)
|
are recommended for simplicity. To achieve this, update the
|
||||||
submodule with:
|
[`speed-dreams-data/`](/speed-dreams-data/) submodule with:
|
||||||
|
|
||||||
```
|
```
|
||||||
git submodule update --init --recursive
|
git submodule update --init --recursive
|
||||||
|
|
BIN
doc/readme/sd-logo.png
Normal file
BIN
doc/readme/sd-logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 86 KiB |
Loading…
Reference in a new issue