README.md

   1 # Nose Ears website
   2
   3 This is the source code for the Nose Ears website, a webcomic by Wuzzy.
   4
   5 ## Building
   6
   7 This is a static website, and you need [Hugo](https://gohugo.io) to generate it.
   8
   9 Just run the `hugo` command in the website directory and get the finished website from the `public` directory. Now it's ready to be uploaded on basically any webhost.
  10
  11 ## Comics
  12 Comic metadata is stored in the `.csv` files, which are CSV files compliant with RFC 4180
  13 <https://datatracker.ietf.org/doc/html/rfc4180>.
  14 Run `python csv_to_content.py` to generate the respective comic Markdown files.
  15
  16 **NOTE**: This repository does NOT include the comic files itselves! They have to be added into `assets/comics` manually.
  17
  18 ## License
  19
  20 [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/).