From a74131c1be5633a32a11b5dd482fd972f7c0a58b Mon Sep 17 00:00:00 2001 From: Robbi Blechdose Date: Fri, 8 Mar 2024 14:15:11 +0100 Subject: [PATCH] Renamed license file and added explanatory paragraph to README --- LICENSE => LICENSE-gb-boilerplate | 0 README.md | 8 ++++++++ 2 files changed, 8 insertions(+) rename LICENSE => LICENSE-gb-boilerplate (100%) diff --git a/LICENSE b/LICENSE-gb-boilerplate similarity index 100% rename from LICENSE rename to LICENSE-gb-boilerplate diff --git a/README.md b/README.md index 9087a11..c20b025 100644 --- a/README.md +++ b/README.md @@ -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`.