adding documentation from rosa to the readme here

README.md

@@ -1,10 +1,79 @@
 # Octomode 
 
-*work-in-process*
+*work-in-progress*
 
 Octomode is a collective editing space for PDF making, using Etherpad, Paged.js and Flask. 
 
-## Use octomode locally
+## How to use Octomode?
+
+If you want to work collectively on making a PDF, you can use octomode. There is an instance installed here: <https://octomode.vvvvvvaria.org/>. You can write any name of in the input field, this will create a new octomode environment. 
+
+Working in octomode includes:
+
+* `pad`: all materials for the PDF are collected here. (written in Markdown)
+* `stylesheet`: all CSS rules for the PDF are collected here (written in CSS)
+* `html`: render the lay out as a HTML (rendered with PyPandoc)
+* `pdf`: render the lay out as a PDF (rendered with Paged.js)
+
+When creating a new environment, a few things happen:
+
+* a pad is created for collecting the materials of your PDF. The name of the octomode environment will become the name of this pad. For example: `http://pad.vvvvvvaria.org/NAME.md`.
+* another pad is created for writing the stylesheet of your PDF. The name of the octomode environment will become the name of this pad, followed by .css. For example: `https://pad.vvvvvvaria.org/NAME.css`
+* If both pads were not created yet, a template is added to the pad. The main pad will get a Markdown template and the stylesheet pad a CSS template.
+
+In case a pad was already made, you can copy the templates below and paste them at the top of your pads.
+
+The PDFs are rendered using [Paged.js](https://pagedjs.org/), a free and open source JavaScript library "that paginates content in the browser to create PDF output from any HTML content. This means you can design works for print (eg. books) using HTML and CSS!" The project is maintained by the [Coko Foundation](https://coko.foundation/). Paged.js adds features to the CSS3 standards, expanding the possibilities to make lay outs for specific sections, place content in the margins of pages, and render indexes (amonst other things). The documentation is very ufesul and can be found here: <https://pagedjs.org/documentation/>.
+
+### Octomode Markdown template
+
+```
+---
+title: tentacular thinking
+language: en
+---
+
+# tentacular thinking
+```
+
+### Octomode CSS template
+
+```
+@charset "utf-8"; 
+
+@page{
+    size: A5;
+}
+
+@page:first{
+    background-color: pink;
+}
+
+body{
+    color: green;
+}
+
+section#cover{
+    page-break-after: always;
+}
+```
+# Continuums
+
+Octomode resonates with other pad-to-pdf software practices, including: 
+
+* Ethertoff http://osp.kitchen/tools/ethertoff/ by OSP
+* Etherbox https://networksofonesown.constantvzw.org/ by Michael Murtaugh/Constant
+* Etherdump https://gitlab.constantvzw.org/aa/etherdump by Michael Murtaugh/Constant
+* Pad2Print https://gitlab.com/Luuse/pad2print by Luuse
+* JupyterPi https://git.xpub.nl/XPUB/jupyterpi by Michael Murtaugh/XPUB
+
+# Use octomode locally
+
+You can clone this repository to run octomode on your own computer or server.
+
+`git clone https://git.vvvvvvaria.org/varia/octomode.git`
+
+`cd octomode`
 
 `make setup` (sets up a virtual environment and install the requirements)
 
@@ -24,14 +93,6 @@ Open the application at <http://localhost:5001>.
 * To keep the flask application running in the background: add a new config to supervisor (`cp /etc/supervisor/conf.d/previousexample.conf new.conf`)
 * Restart supervisor (`sudo service reload supervisor`)
 
-# Refs
-
-* Ethertoff http://osp.kitchen/tools/ethertoff/ by OSP
-* Etherbox https://networksofonesown.constantvzw.org/ by Michael Murtaugh/Constant
-* Etherdump https://gitlab.constantvzw.org/aa/etherdump by Michael Murtaugh/Constant
-* Pad2Print https://gitlab.com/Luuse/pad2print by Luuse
-* JupyterPi https://git.xpub.nl/XPUB/jupyterpi by Michael Murtaugh/XPUB
-
 # Snapshots
 
 ![](snapshots/breakybreaky-in-octomode-1.png)