jujuforce/segatools
1
0
Fork 0
forked from Dniel97/segatools
Code Pull Requests Activity

Overhaul root readme

Browse Source 
Provide a more user/developer-friendly entry point to the project
This commit is contained in:
icex2 2021-04-10 15:04:28 +02:00
parent 7db3d4af47
commit 76dbbdd665
1 changed files with 57 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -1,16 +1,64 @@
# Segatools
Quick start on a Linux build host:
Version: `v005`
```
# Install Meson and a recent build of MinGW-w64, then:
Loaders and hardware emulators for SEGA games that run on the Nu and ALLS platforms.
$ meson --cross cross-mingw-32.txt _build32
$ ninja -C _build32
$ meson --cross cross-mingw-64.txt _build64
$ ninja -C _build64
## List of supported games
* Chunithm
* [Chunithm (Plus)](doc/chunihook.md)
* [Chunithm Air (Plus)](doc/chunihook.md)
* [Chunithm Star (Plus)](doc/chunihook.md)
* [Chunithm Amazon (Plus)](doc/chunihook.md)
* [Chunithm Crystal (Plus)](doc/chunihook.md)
* Initial D
* Initial D Zero
## End-users
For setup and configuration guides, refer to the dedicated documents available for each game, see
[the links in the previous section](#list-of-supported-games).
## Developers
### Building
The root `Makefile` contains various targets that allow you to build the project easily.
#### Local build
For a local build, you need to install Meson and a recent build of MinGW-w64. Then you can start the
build process:
```shell
make build
```
Building on MSYS2 is also possible; consult Meson documentation for details.
Build output will be located in `build/build32` and `build/build64` folders.
Additional documentation will be forthcoming.
#### Cleanup local build
```shell
make clean
```
#### Create distribution package (zip file)
```shell
make dist
```
The output will be located in `build/zip`.
#### Build and create distribution package using docker
You can also build using docker which avoids having to setup a full development environment if you
are just interested in building binaries of the latest changes. Naturally, this requires you to
have the docker daemon installed.
```shell
make build-docker
```
Once completed successfully, the build output is located in the `build/docker/zip` sub-folder.