Cool_Tools/bemanitools
1
0
Fork 0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2025-02-28 23:52:18 +01:00
Code Releases Activity

Update readme/development doc about docker building

Browse Source
This commit is contained in:
icex2 2020-05-11 00:24:21 +02:00
parent 13d29cb62e
commit 7157fdedb7
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -81,6 +81,9 @@ should cover most if not all of the games so far
Please refer to the [dedicated documentation](CONTRIBUTING.md). Please refer to the [dedicated documentation](CONTRIBUTING.md).
# Development # Development
## Building
See the [development document](doc/development).
## Architecture ## Architecture
A dedicate [architecture document](doc/architecture.md) outlines the architecture of Bemanitools and points out the most 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. 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 ## API
Please refer to the [API documentation](doc/api.md). 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 # License
Source code license is the Unlicense; you are permitted to do with this as thou wilt. For details, please refer to the 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. [LICENSE file](LICENSE) included with the source code.

12
doc/development.md
View File

@ -58,6 +58,18 @@ command:
make release 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 ## Creating releases
For developers to create official releases with major and minor versioning: 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. 1. Ensure that all everything you want to have for this release is merged into master.