add README

lipu-tenpo · Jan 15, 2024 · ac8b306 · ac8b306
1 parent ae0879f
commit ac8b306
Showing 1 changed file with 58 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -6,22 +6,65 @@ See live on <https://liputenpo.alifeee.co.uk/>
 
 Under construction
 
-## Folder structure
-
-```text
-_data
-  linluwi.yaml (external links)
-  lipu_ale.yaml (all issue information)
-_includes
-  base html template (for <head>)
-  frame html template (for header/footer)
-public
-  static site stuff (favicons/images/stylesheets)
-index.html (main page layout)
-lipu.html (layout of issue page(s))
-```
+## How-to
+
+The following should be done on a **branch** of the [main repository](https://github.com/lipu-tenpo/liputenpo.org). When ready, it can be merged into the [staging repository](https://github.com/lipu-tenpo/liputenpo.org.test), to see what it looks like online, and test links and images.
+
+Only **THEN** should it be pushed to `main` of the [main repository](https://github.com/lipu-tenpo/liputenpo.org).
+
+### Add a new *lipu*
+
+1. Add the new PDFs to the [./pdfs](./pdfs/) folder.
+1. Edit [`_data/lipu_ale.yaml`](./_data/lipu_ale.yaml) and add the new article. For example,
+
+     ```yaml
+     - id: 23
+       title: nanpa sewi
+       date: 2023-12-25
+       pdf: 0023sewi.pdf
+       pdf_pf: 0023sewi_pf.pdf
+       pdf_bwpf: 0023sewi_bwpf.pdf
+       cover_image: 0023sewi_sinpin.png
+     ```
+
+1. Wait for site to build - see status on the [actions tab](https://github.com/lipu-tenpo/liputenpo.org/actions)
+1. Merge into main branch of staging site
+1. Check links and images
+1. Merge into main branch of main site
+
+## Add a new *toki*
+
+1. Create a new markdown file in the sub-folder of the issue the toki is from in [`./toki`](./toki/)
+1. Create the frontmatter for the file with the `TITLE`, `AUTHOR(S)`, `DATE`, and `TAGS` (article type), for example
+
+      ```yaml
+      ---
+      nimi-suli: nasin tawa Intawe
+      jan-pali: jan Alipi
+      tags:
+        - sona
+      ---
+      ```
+
+1. Upload any images to [`./toki/images/`](./toki/images/)
+1. Paste the content into the article
+    - Use the image shortcode for images, e.g., `{{{sitelen "nasin-tawa-intawe.png" "nasin tawa Intawe"}}}`
+    - Use the non-pu shortcode for non-pu words, e.g., `{{{pu "kipisi"}}}`
+    - Shortcodes are defined in [`./.eleventy.js`](./.eleventy.js)
+1. Wait for site to build - see status on the [actions tab](https://github.com/lipu-tenpo/liputenpo.org/actions)
+1. Merge into main branch of staging site
+1. Check links and images
+1. Merge into main branch of main site
+
+## Edit jan pali
+
+Edit [`./_data/jan_pali.yaml`](./_data/jan_pali.yaml)
+
+## Edit other data on the site
+
+It's probably in a file in [`./_data`](./_data/).
 
-## Commands
+## Development Commands
 
 ### Install