Make README

README.md

@@ -0,0 +1,29 @@
+# staticoso
+
+**staticoso** (_from Italian statico [static] + coso [thingy]_) is an unpretentious static site generator.
+
+I'm making this because I need a simple and kind-of-minimal program to serve me as a static site generator with (limited) CMS features. Just the features I need.
+
+This won't replace any of the big projects out there that do the same thing but, as all of my projects, I'm releasing it as free libre software, in the hope that someone would find it useful.  
+Also, this software is needed for someone to edit and compile my personal sub-website [postoctt](https://octtspacc.gitlab.io/postoctt) from its source. Being that site too released under a libre license that allows modifications, I have to also release the tools I use to build it.
+
+Feel free to experiment with all of this stuff!
+
+## Dependencies
+- [Python >= 3.10.4](https://python.org)
+- [Python Markdown >= 3.3.7](https://pypi.org/project/Markdown)
+- [pug-cli >= 1.0.0-alpha6](https://npmjs.com/package/pug-cli)
+
+## Features roadmap
+- [] SCSS compilation support for CSS templates
+- [] Pug support for base templates and page side parts
+- [] Differential recompile (to optimize resource waste on non-ephemeral servers)
+- [] Hot-recompile (for website development)
+- [] XML sitemap generation
+- [] RSS feed generation
+- [] Generation of website page tree in left sidebar
+- [x] Generation of titles in right sidebar with clickable links
+- [x] Detections of titles in a page
+- [x] Pug support for pages
+- [x] Markdown support for pages
+- [x] First working version

Source/Build.py

@@ -2,7 +2,9 @@
 """ ================================= |
 | staticoso                           |
 | Just a simple Static Site Generator |
-| Licensed under AGPLv3 by OctoSpacc  |
+|                                     |
+| Licensed under the AGPLv3 license   |
+| Copyright (C) 2022, OctoSpacc       |
 | ================================= """
 
 import os