diff --git a/README.md b/README.md index 653e58a..a1db020 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,9 @@ should cover most if not all of the games so far Please refer to the [dedicated documentation](CONTRIBUTING.md). # Development +## Building +See the [development document](doc/development). + ## Architecture A dedicate [architecture document](doc/architecture.md) outlines the architecture of Bemanitools and points out the most important aspects you should know before you get started with development. @@ -88,10 +91,6 @@ important aspects you should know before you get started with development. ## API Please refer to the [API documentation](doc/api.md). -## Source Code -The source code is included with this distribution package (src.zip). Please refer to the -[development document](doc/development.md) for further details. - # License Source code license is the Unlicense; you are permitted to do with this as thou wilt. For details, please refer to the [LICENSE file](LICENSE) included with the source code. diff --git a/doc/development.md b/doc/development.md index 00fc769..1e5ea18 100644 --- a/doc/development.md +++ b/doc/development.md @@ -58,6 +58,18 @@ command: make release ``` +## Building with docker +You can also build bemanitools using docker which avoids having to setup a full development +environment if you are just interested in building binaries for the latest changes. Naturally, this +requires you to have the docker daemon installed. Then, run the following command from the root +folder of the project: + +```bash +make build-docker +``` + +Once completed successfully, the build output is located in the `build/docker` sub-folder. + ## Creating releases For developers to create official releases with major and minor versioning: 1. Ensure that all everything you want to have for this release is merged into master.