Skip to content

Commit 8f6f420

Browse files
committed
Basic documentation of build process
1 parent c2d3465 commit 8f6f420

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,19 @@ display.draw(25, 4, "#", "#f00", "#009"); // and background color
4141

4242
The pre-bundled rot.js package can be loaded as a CommonJS module. There is an [example](examples/node/) that shows basic usage.
4343

44+
## Contributing
45+
46+
ROguelike Toolkit is largely considered "feature-complete", but bugfixes, documentation, and some new features are welcomed. Development should happen in the `/src` folder, and then the build process creates the `/lib`, `/dist`, and `/doc` folders before serving the project.
47+
48+
![Visual layout of the build process](./build.png)
49+
50+
The command to rebuild everything:
51+
52+
```sh
53+
npm install
54+
make all
55+
```
56+
4457
## Misc
4558

4659
RogueBasin page (with links to some rot.js-based games): http://roguebasin.com/index.php/Rot.js

0 commit comments

Comments
 (0)