added readme

This commit is contained in:
sejo 2021-06-16 20:21:13 -05:00
parent beb671d61d
commit 16e49db815
1 changed files with 31 additions and 0 deletions

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# compudanzas
this repository contains the scripts and source files for the compudanzas site
* generated in web/ : [compudanzas.net](https://compudanzas.net)
* generated in gem/ : online soon
# generate site
call the shell script:
```
./generasitio.sh
```
# files
* generasitio.sh: the shell script that copies files and call the other scripts
* gemtext2html.awk: converts the files in .gmo format (modified .gmi) to an html version, according to the spec and my own taste
* gmo2gmi.awk: converts the files in .gmo format to real .gmi
* genindice.awk: generates the index of all pages
* links.py: calculates the incoming links between pages and adds them to the files
gemtext2html.awk and gmo2gmi.awk also parse and convert {wikilinks}
# .gmo format
the same format as gmi (gemtext), but with the following line types:
+ add this line to the html file but not to the gmi file
& add this line to the gmi file but not to the html file