From 9206827fc24a05812609394a8810b2a02d11d60b Mon Sep 17 00:00:00 2001 From: LMBishop <13875753+LMBishop@users.noreply.github.com> Date: Sat, 30 Sep 2023 21:12:14 +0100 Subject: Remove expired links from docs --- docs/README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/README.md (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..9b1d20d3 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,36 @@ +# Quests documentation + +This directory contains the documentation for Quests. You can +build it using Jekyll, or view it online at +[https://quests.leonardobishop.com/](https://quests.leonardobishop.com/). + +## Building + +To build the documentation, you will need to install Jekyll. You can +do this by following the instructions on the +[Jekyll website](https://jekyllrb.com/docs/installation/). + +Once you have Jekyll installed, you can build the documentation by +running `jekyll build` in this directory. The documentation will be +built into the `_site` directory. + +``` +bundle exec jekyll build +``` + +Alternatively, you may use the pre-defined docker-compose.yml file to +build and serve the documentation. + +``` +docker compose up --build +``` + +## Contributing + +See [contributing-to-the-wiki.md](contributing-to-the-wiki.md). +(Online version: +[https://quests.leonardobishop.com/contributing-to-the-wiki.html](https://quests.leonardobishop.com/contributing-to-the-wiki.html) + +## License + +This documentation is subject to the same license as Quests itself. \ No newline at end of file -- cgit v1.2.3-70-g09d2