From 971fa53b05f796239b37f96e68acda40d8dd9656 Mon Sep 17 00:00:00 2001 From: Leo Gavilieau Date: Tue, 23 May 2023 22:14:27 +0200 Subject: [PATCH] feat: Add more info to README [CI SKIP] --- LICENSE | 0 README.md | 16 +++++++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 845882e..6edc31e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ # vern/wiki -Where we are planning our migration from dokuwiki to markdown. +This repository contains all the neccessary tools (content, build utils and stylesheets) neccessary to deploy the ~vern wiki. ## Status -All english pages have been translated. Site layout is mostly finished. +All english pages have been translated. Site layout is finished. It's A-Okay to deploy this! +## Copyright + +Copyright © ~vern and Wiki contributors. All text, images and so on are licensed under the CC-BY-SA 4.0 International license. + +A copy of the license can be found in the `LICENSE` file, a list of authors and contributors can be found in the `utils/authors.md` file. + +### Translating the ~vern wiki? Get in touch! + +Please get in touch with the [wiki maintainers](https://wiki.vern.cc/en/staff/#wiki) so we can help you out and credit you properly in the Authors file. + ## How to build You will need your favorite `make` command (We recommend GNU make), pandoc and some common Unix shell utilities. -Run `make` to build the entirety of the wiki. \ No newline at end of file +Run `make` to build the entirety of the wiki. The end-result should be available in the `output/` folder. \ No newline at end of file