phx_literate/template/$PROJECT_NAME$

<%= @project_name %>

• Table of Contents
• Building

This project is a repository of Org Mode formatted documents which describe and implement a web service written in Elixir using the Phoenix Framework.

Rather than directly editing the source code, these documents are edited instead – source code, justification and the links between disparate modules and data-flows expressed in text as well as code.

Table of Contents

• Project Configuration, Mix, etc
• <%= @project_name %> backend application
• <%= @project_name %> Phoenix Frontend
• The Visual Identity of <%= @project_name %>
• Controller for static <%= @project_name_camel_case %>Web pages
• <%= @project_name %> Test Support

Building

There is a Makefile to make it easier to tangle the files. You will need Emacs and Org-mode installed for this to work. Some day all of this will be in Mix tasks that can contain the whole set of dependencies.

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.