slinky55/Binx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Renamed license file and added explanatory paragraph to README

Browse Source
This commit is contained in:
Robbi Blechdose
2024-03-08 14:15:11 +01:00
committed by Eldred Habert
parent 94ea749c25
commit a74131c1be
2 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
LICENSE → LICENSE-gb-boilerplate
View File

8
README.md
View File

@@ -25,6 +25,14 @@ Always comes in handy.
If you want to add resources, I recommend using the `src/assets` directory.
Add rules in the Makefile; an example is provided for compressing files using PB16 (a variation of [PackBits](https://wiki.nesdev.com/w/index.php/Tile_compression#PackBits)).
## Licensing
You must keep LICENSE-gb-boilerplate in your repository, but it will not affect the rest of your project (i.e. your files).
Attribution in the README is appreciated, for instance like this:
```
This project uses the [gb-boilerplate](https://github.com/ISSOtm/gb-boilerplate) template by ISSOtm, under the zlib license.
```
## Compiling
Simply open you favorite command prompt / terminal, place yourself in this directory (the one the Makefile is located in), and run the command `make`.