
# Table of Contents

1.  [Summary](#orgb6209fd)
2.  [Setup](#orgf97522b)
3.  [Export](#org9ccd8fa)



<a id="orgb6209fd"></a>

# Summary

This repository contains small org examplesz;

-   README.org &#x2013; this file.
-   Ctangle.org &#x2013; shows how to run a C program.

Finally, the *Makefile* itself is a crucial piece of information as it shows how you might make the environment available to people
who don't use Emacs.


<a id="orgf97522b"></a>

# Setup

To run these examples, the easiest thing to do is install [Emacs on OSX](https://emacsformacosx.com/) and ensure orgmode and htmlize are installed.
Likewise, the *Makefile* is written for [GNU make](https://www.gnu.org/software/make/) and it's also likely I did something ages ago to ensure I had a working C compiler.


<a id="org9ccd8fa"></a>

# Export

Beyond extracting any code, the `org_tangle.el` file also exports the documents to html and markdown.
Since the object is to read the documents and [Fossil](https://fossil-scm.org) can display markdown but not org files, the generated
markdown is also checked in as documentation.

