From ee6a5678426c2df9a73c99a253d31954bf4cf6dd Mon Sep 17 00:00:00 2001 From: Rafael Mardojai CM Date: Tue, 19 Dec 2023 08:56:16 -0500 Subject: [PATCH] Add README --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd77ea7 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Dialect's Website + + +## Development + +The only dependency to build the website is the [Hugo](https://gohugo.io/) static site generator extension edition. + +See the [installation instructions](https://gohugo.io/installation/). + +```sh +sudo dnf install hugo # Fedora +``` + +To start the hugo live server run: + +```sh +hugo server +``` + +## Building + +To build a copy of the website to the `/public` folder run: + +```sh +hugo -D +``` + +## License + +The code of this website is licensed under the [MIT license](https://github.com/dialect-app/website/blob/main/LICENSE). + +The content of the website is licensed under the [CC BY-SA 4.0 license](http://creativecommons.org/licenses/by-sa/4.0/).