commit 21c9fbd1913bf952e065511086fbfcd685bdb602
parent 6595feb811ea8b90a66e08e1bab475fcfd3b891f
Author: Christoph Lohmann <20h@r-36.net>
Date:   Tue, 21 Jan 2014 09:31:45 +0100
Add a description and an example for a presentation.
Diffstat:
8 files changed, 82 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# Pointtools
+
+These  tools  are scripts and ways to present point files. They are pre‐
+formatted text files presented in catpoint(1). In /bin is  a  script  to
+easily convert markdown files to point files.
+
+See the examples/hello directory for how to use it in real life:
+
+	% cd catpoint
+	% make
+	% cp catpoint $HOME/bin
+	% cp ../bin/* $HOME/bin
+	% cd ../examples/hello
+	% cat hello.md | md2point
+	% catpoint *.txt
+
+There are not many formatting options for now, but it’s enough for daily
+usage. If you need any graph or formatting, use  troff(1)  and  all  the
+formatting available there.
+
+Have fun!
+
diff --git a/bin/md2point b/bin/md2point
@@ -1,4 +1,7 @@
 #!/bin/sh
+#
+# See LICENSE for license details.
+#
 
 mkfilename() {
 	printf "%.4d-%s" "$1" "$2" | tr '# :.' '_'
diff --git a/bin/point2pdf b/bin/point2pdf
@@ -1,4 +1,7 @@
 #!/bin/sh
+#
+# See the LICENSE file for license details.
+#
 
 name="slides"
 [ $# -gt 0 ] && name="$1"
diff --git a/examples/hello/0000-_Intro.txt b/examples/hello/0000-_Intro.txt
@@ -0,0 +1,7 @@
+
+   Intro
+  =======
+
+  
+  This is the Hello World introduction to catpoint.
+  
diff --git a/examples/hello/0001-_A_new_slide.txt b/examples/hello/0001-_A_new_slide.txt
@@ -0,0 +1,7 @@
+
+   A new slide
+  =============
+
+  
+  Just show something on this new slide.
+  
diff --git a/examples/hello/0002-_Some_points.txt b/examples/hello/0002-_Some_points.txt
@@ -0,0 +1,12 @@
+
+   Some points
+  =============
+
+  
+  o point
+  o point
+          o sub point
+          o sub point
+          	o sub sub point
+          o sub point
+  
diff --git a/examples/hello/0003-_Ende.txt b/examples/hello/0003-_Ende.txt
@@ -0,0 +1,7 @@
+
+   Ende
+  ======
+
+  
+  Thanks for using cattools.
+  
diff --git a/examples/hello/hello.md b/examples/hello/hello.md
@@ -0,0 +1,21 @@
+## Intro
+
+This is the Hello World introduction to catpoint.
+
+## A new slide
+
+Just show something on this new slide.
+
+## Some points
+
+* point
+* point
+	* sub point
+	* sub point
+		* sub sub point
+	* sub point
+
+## Ende
+
+Thanks for using cattools.
+