summaryrefslogtreecommitdiff
path: root/web/clojure-pamphlet/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /web/clojure-pamphlet/README
Initial commit
Diffstat (limited to 'web/clojure-pamphlet/README')
-rw-r--r--web/clojure-pamphlet/README38
1 files changed, 38 insertions, 0 deletions
diff --git a/web/clojure-pamphlet/README b/web/clojure-pamphlet/README
new file mode 100644
index 0000000000..00b7603d76
--- /dev/null
+++ b/web/clojure-pamphlet/README
@@ -0,0 +1,38 @@
+CLOJURE PAMPHLET SYSTEM
+===========
+
+The clojure pamphlet system is a system based on the clojure literate
+system. In the clojure's pamphlet system you have your main LaTeX
+file, which can be compiled regularly. This file contains
+documentation and source code (just like in other forms of literate
+programming). This code snippets are wrapped in the 'chunk'
+environment, hence they can be recognized by the tangler in order to
+extract them. Chunks can be included inside each other by the
+'getchunk' command (which will be typesetted acordingly). Finally, you
+run your LaTeX file through the tangler and get your desired chunk of
+code.
+
+See the INSTALL file for detailed information about how to configure
+and install the tangler.
+ This tangler is a program that takes a pamphlet latex file (A simple
+latex file with special commands in it, see the latex clojure-pamphlet
+package manual page) and a code section and outputs the specified code
+section adding the chunks that are needed (and can be in any other
+part of the document).
+
+-----
+
+Copyright (C) 2019, Ernesto Lanchares Sanchez.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3, or (at your option)
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.