Makefile and README

Ryan Rix 2020-08-09 17:16:46 -07:00
parent c8dcf7545b
commit 6c44fc38af
4 changed files with 38 additions and 1 deletions

Makefile Normal file
View File

@ -0,0 +1,17 @@
ORG_FILES = $(wildcard *.org)
tangle: $(TOUCH_FILES)
@echo "Tangled files:"
@echo $(ORG_FILES)
emacs --batch --no-init-file --load lisp/babel.el \
--find-file $< --funcall org-babel-tangle --kill
touch $@
.PHONY: init
init: tangle
mix deps.get
mix deps.compile
cd assets; npm install

19 Normal file
View File

@ -0,0 +1,19 @@
#+TITLE: Lipu Kasi - A Plant Diary
Lipu Kasi is [[][Tokipona]] for Plant Diary, Lipu Kasi is a simple Plant Diary. It's a [[][Phoenix Framework]] web application developed as [[][org-mode]] Literate Programming using [[][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]] development philosophies in to a new domain, a pure [[file:../][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
- [[][§Project Configuration, Mix, etc]]
- [[][§LipuKasi backend application]]
- [[][§Lipu Kasi Phoenix Web Frontend]]
- [[][§The Visual Identity of Lipu Kasi]]
- [[][§Controller for static Lipu Kasi pages]]
* 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.

View File

@ -1,4 +1,4 @@
#+TITLE: The Visual Ideology of Lipu Kasi
#+TITLE: The Visual Identity of Lipu Kasi
This application should feel earthy and home-y, an application for individuals by individuals. It should look as smart on a laptop as a phone, and be as functional both ways.

lisp/babel.el Normal file
View File

@ -0,0 +1 @@
(require 'ob)