move press kit to root

This commit is contained in:
ohsqueezy 2024-03-20 21:53:39 -04:00
parent 2d95172b15
commit 8b3efa64c2
3 changed files with 3 additions and 3 deletions

View File

@ -371,7 +371,7 @@ Cakefoot-win32-ARCADE_ONLY.exe: $(addprefix $(ARCADE_BUILD_DIR)/, glew.o SDL2_ro
# Generate an HTML page from the Press Kit Markdown file. This requires the document conversion tool Pandoc <https://pandoc.org/>.
press :
pandoc -H "src/Press_kit_style.html" --metadata-file="src/Press_kit_metadata.yml" -s -o press.html doc/Press_kit.md
pandoc -H "src/Press_kit_style.html" --metadata-file="src/Press_kit_metadata.yml" -s -o press.html Press_Kit.md
###################
# Make all builds #

View File

@ -39,11 +39,11 @@ To build on Linux, for example, once SPACE🪐BOX is confirmed to be working, ru
Press kit
=========
There is a [press kit](doc/Press_kit.md) included in Markdown format in the `doc/` folder. This can be converted into an HTML page using the conversion tool [Pandoc](https://pandoc.org/). Once Pandoc is installed, run the make target from the terminal to generate a file `press.html` in the root folder.
There is a [press kit](Press_kit.md) included in Markdown format in the root of the repository. This can be converted into an HTML page using the conversion tool [Pandoc](https://pandoc.org/). Once Pandoc is installed, run the make target from the terminal to generate a file `press.html` in the root folder.
$ make press
The generated page will look like [this](https://cakefoot.dank.game/press.html). To edit the press kit, for example if this repository is being used as a skeleton for another game or a mod, edit the [markdown file](doc/Press_kit.md), [CSS rules](src/Press_kit_style.html), and [metadata](doc/Press_kit_metadata.yml), and re-run the make target.
The generated page will look like [this](https://cakefoot.dank.game/press.html). To edit the press kit, for example if this repository is being used as a skeleton for another game or a mod, edit the [markdown file](Press_kit.md), [CSS rules](src/Press_kit_style.html), and [metadata](src/Press_kit_metadata.yml), and re-run the make target.
License
=======