lipu_kasi/README.org

21 lines
1.8 KiB
Org Mode

#+TITLE: Lipu Kasi - A Plant Diary
Lipu Kasi is [[https://en.wikipedia.org/wiki/Tokipona][Tokipona]] for Plant Diary, Lipu Kasi is a simple Plant Diary. It's a [[https://www.phoenixframework.org/][Phoenix Framework]] web application developed as [[http://org-mode.org/][org-mode]] Literate Programming using [[https://orgmode.org/worg/org-contrib/babel/intro.html][org-babel]]. Right now it's using only the tangle/detangle/noweb features of this, none of the inter-mingling of different languages and data. This is an experiment in extending my [[file:../cce.org][CCE]] development philosophies in to a new domain, a pure [[file:../literate_programming.org][Literate Programming]] system from the ground up. So keep that in mind. I intend to make it at least somewhat possible to work "outside" of the org-mode documents, but it will be more difficult to contribute that way and I'm likely to reject any patches that don't update the documentation alongside the code.
* Table of Contents
- [[file:phoenix.org][§Project Configuration, Mix, etc]]
- [[file:lipu_kasi.org][§LipuKasi backend application]]
- [[file:lipu_kasi_web.org][§Lipu Kasi Phoenix Web Frontend]]
- [[file:aesthetics.org][§The Visual Identity of Lipu Kasi]]
- [[file:page_controller.org][§Controller for static Lipu Kasi pages]]
- [[file:testing.org][§Lipu Kasi Test Support]]
* Building
There is a [[file:Makefile][Makefile]] to make it easier to tangle the files.
=make tangle= will tangle any org document which is newer than a handle left in =_build=. It's important to keep your tangled documents up to date with the file system, but for development it's likely that you're sending the Elixir code to a running =IEx= session, there will be an org-mode documentation providing for this at some point soon.
=make init= will tangle, download dependencies, and compile them.