From f1a3e785c8797d794551374e2a119cd5152cea97 Mon Sep 17 00:00:00 2001 From: Atlas Cove Date: Thu, 9 Feb 2023 15:12:01 +0000 Subject: [PATCH] Create README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c81f2c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Atlas48's Neocites Archives +Welcome to the technical documentation for my [Neocities](https://neocities.org] page, which also contains a rudimentary static site generator cobbled together out of unix tools +and Ruby scripts + +# License +All markup is licensed under the Creative Commons [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/) license. +Any runnable computer code or Sass/CSS definitions are licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html) +# Specification +## Dependencies +You will need the following tools to render and upload the site +- [neo-cli](https://neo-cli.neocities.org/) +- [RedCloth](http://redcloth.org/) +- [org-ruby](http://github.com/bdewey/org-ruby) +- [comrak](https://github.com/kivikakk/comrak) +## `Makefile` +Wraps `render.sh` as well as either `neo` or `rclone`. +### Makefile Options +#### `list` +Lists all components in a heading-annotated list +#### `list-{doc,sass,dir,rest}` +Lists markup files, sass files, directories, and other files respectively. +#### `clean` +Removes the `out/` directory that is generated on running of `render.sh`. +#### `push` +Uploads the site to neocities.org. +## `render.sh` +The primary worker script, sets up the directory structure, transpiles the markup, then the Sass, then copies the contents of `in/` to `out/`