Archive/TRX
0
0
Fork 0
mirror of https://github.com/LostArtefacts/TRX.git synced 2025-04-28 20:58:07 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: extract CONTRIBUTING.md

Browse source
This commit is contained in:
rr- 2021-02-12 13:47:17 +01:00
parent da590be98f
commit f937f5e23f
No known key found for this signature in database
GPG key ID: CC65E6FD28CAE42A
2 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,15 @@
## Contributing
- i686-w64-mingw32-gcc - C/C++ compiler
- Vim @ WSL - IDE
To compile the project, run `make build`.
To compile the project with Docker, run `make docker_build`.
Each function should be ported in a separate commit. After porting each
function, you should update the progress map by editing the `docs/progress.txt`
file and executing `make docs`.
This project uses `clang-format` to take care of automatic code formatting. To
ensure your code conforms to the standard, please run `make lint` after each
commit.

8
README.md
View file

@ -28,14 +28,6 @@ Currently the following configuration options are supported:
- `fix_end_of_level_freeze`: fix game freeze when ending the level with the
Action key held.
## Building
- i686-w64-mingw32-gcc - C/C++ compiler
- Vim @ WSL - IDE
To compile the project, run `make build`.
To compile the project with Docker, run `make docker_build`.
## Decompilation progress
![](docs/progress.svg)