Replace README.txt with README.md
This commit is contained in:
parent
7bd0fe9fa9
commit
f9b820229f
GPG key ID:
84FF3612A9BF43F2
3 changed files with 57 additions and 71 deletions
57
README.md
Normal file
57
README.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
# Speed Dreams
|
||||
|
||||
Speed Dreams is a free and open source motorsport simulator. Originally
|
||||
a fork of the [TORCS](https://torcs.sourceforge.net/) project,
|
||||
it has evolved into a higher level of maturity, featuring realistic physics
|
||||
with tens of high-quality cars and tracks to choose from.
|
||||
|
||||
> **This repository only contains the engine source code.**
|
||||
> **End users are expected to download the pre-built packages listed below.**
|
||||
>
|
||||
> The assets repository is located on
|
||||
> https://forge.a-lec.org/speed-dreams/speed-dreams-data/
|
||||
|
||||
|
||||
|
||||
## Pre-built packages
|
||||
|
||||
Speed Dreams binaries are available for the following platforms:
|
||||
|
||||
- Debian/Ubuntu (TODO)
|
||||
- Microsoft Windows (TODO)
|
||||
|
||||
## Building from source
|
||||
|
||||
Speed Dreams can be built from source using the conventional build process
|
||||
in CMake projects:
|
||||
|
||||
```
|
||||
cmake -B build
|
||||
cmake --build build/ # Optionally, add -j8 or any other number for faster builds
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
#### Debian/Ubuntu
|
||||
|
||||
```
|
||||
sudo apt install git cmake build-essential libopenscenegraph-dev libcurl4-gnutls-dev libsdl2-dev libsdl2-mixer-dev librhash-dev libenet-dev libpng-dev libjpeg-dev zlib1g-dev libminizip-dev libopenal-dev libplib-dev libexpat1-dev libcjson-dev openjdk-17-jdk openjdk-17-jre
|
||||
```
|
||||
|
||||
> The version for the `openjdk-*` packages might change among distributions.
|
||||
|
||||
## License
|
||||
|
||||
By default, Speed Dreams code is licensed under the GPLv2-or-later license,
|
||||
as specified by the [`LICENSE`](./LICENSE) file, whereas non-functional data
|
||||
is licensed under the [Free Art License](http://artlibre.org/) by default.
|
||||
|
||||
However, some sections of the code and some other assets are distributed under
|
||||
various free (as in freedom) licenses. Please read their license files
|
||||
located in their respective directories for further reference.
|
||||
|
||||
## Trademark disclaimer
|
||||
|
||||
Windows is a registered trademark of Microsoft Corporation.
|
||||
|
||||
Ubuntu is a registered trademark of Canonical Ltd.
|
||||
71
README.txt
71
README.txt
|
|
@ -1,71 +0,0 @@
|
|||
Introduction
|
||||
------------
|
||||
This is an all in one package of Speed Dreams. Be aware that some included
|
||||
artwork has non free (in the GPL sense) licenses, you will find a "readme.txt"
|
||||
in those directories.
|
||||
The rest is either licensed under the GPL V2 (see COPYING.txt) or the Free Art License.
|
||||
|
||||
|
||||
Non-Free content (in GPL sense)
|
||||
-------------------------------
|
||||
Here the list with the directories containing non free content, look at the
|
||||
readme.txt for details:
|
||||
- <empty list>
|
||||
|
||||
|
||||
Changes since last release
|
||||
--------------------------
|
||||
See CHANGES.txt
|
||||
|
||||
|
||||
Things that are still to be done, ideas to be ...
|
||||
-------------------------------------------------
|
||||
See TODO.txt
|
||||
|
||||
|
||||
Installation instructions
|
||||
-------------------------
|
||||
See INSTALL.txt
|
||||
|
||||
|
||||
Testing
|
||||
-------
|
||||
If you find problems which should be already fixed or new ones
|
||||
please report them to the speed-dreams-users mailing list.
|
||||
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
During the game press F1
|
||||
(do it as well during the ride to learn about the options).
|
||||
|
||||
For more in depth information visit https://sourceforge.net/projects/speed-dreams/,
|
||||
you'll hopefully find there some information (documentation, HOWTO, FAQ ... work-in-progress).
|
||||
|
||||
If you are stuck please report problems through speed-dreams-users mailing list
|
||||
or our Tracker (visit https://sourceforge.net/p/speed-dreams/tickets/ and login to SF.net for that).
|
||||
|
||||
|
||||
Car Setups
|
||||
----------
|
||||
You can have you own version on the car setups for the human driver
|
||||
- Linux : ~/.speed-dreams-2/drivers/human/...
|
||||
- Windows : <My documents>\speed-dreams-2.settings\human\...
|
||||
depending on the car used. You can change them with a text editor,
|
||||
for more information look into the robot tutorial chapter 5
|
||||
(http://www.berniw.org/tutorials/robot/).
|
||||
|
||||
|
||||
Creating Tracks
|
||||
---------------
|
||||
There is a track editor in development, have a look at https://sourceforge.net/p/speed-dreams/discussion/
|
||||
|
||||
|
||||
Robot programming
|
||||
-----------------
|
||||
You find a robot programming tutorial on www.berniw.org in the TORCS section.
|
||||
|
||||
|
||||
Robot racing
|
||||
------------
|
||||
Visit www.berniw.org/trb for more information.
|
||||
BIN
doc/readme/collage.jpg
Normal file
BIN
doc/readme/collage.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 132 KiB |
Loading…
Reference in a new issue