Add README

This commit is contained in:
Rafael Mardojai CM 2023-12-19 08:56:16 -05:00
parent e1910ef197
commit ee6a567842
No known key found for this signature in database
GPG key ID: 2B2DAB2A58566C84

32
README.md Normal file
View file

@ -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/).