Reorganized documentation to clean doc/ for user-readable files

diff --git a/Makefile b/Makefile
index 03889332adfab43b8abdff9b04574c97cde9b15e..ad78ccb3fc4676f480bc9c610e570198b027421a 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -27,7 +27,7 @@ SHELL = /bin/bash
 PATH = /usr/bin:/bin
 
 # Directories with semantic meaning
-DOC_DIR := doc
+DOC_DIR := doc/src
 
 # Variables that will be extended by module include files
 GENERATED_FILES := libbe/_version.py build

diff --git a/README b/README
index 031ae131847e5cb081c2a23d65773cf2f0efb4a9..428ca86bd9ea82aa954c0cf64b89c0e7471a67a8 100644 (file)
--- a/README
+++ b/README
@@ -21,3 +21,10 @@ To create bugs, use "be new $DESCRIPTION".  To comment on bugs, you
 can can use "be comment $BUG_ID".  To close a bug, use "be close
 $BUG_ID" or "be status $BUG_ID fixed".  For more commands, see "be
 help".  You can also look at the usage examples in test_usage.sh.
+
+Documentation
+=============
+
+If "be help" isn't scratching your itch, there's also
+  * doc/tutorial        (a gentle introduction to BE)
+  * doc/README.dev      (a guide to hacking BE)

diff --git a/doc/SPAM b/doc/spam
similarity index 100%
rename from doc/SPAM
rename to doc/spam

diff --git a/doc/be.1.sgml b/doc/src/be.1.sgml
similarity index 100%
rename from doc/be.1.sgml
rename to doc/src/be.1.sgml

diff --git a/doc/module.mk b/doc/src/module.mk
similarity index 98%
rename from doc/module.mk
rename to doc/src/module.mk
index 960f7c032bbf4dcdf7d953c667a6719d260ca376..ea4eacc6a7be732dc859e8ac72a21f306a60fd65 100644 (file)
--- a/doc/module.mk
+++ b/doc/src/module.mk
@@ -23,7 +23,7 @@
 
 # Makefile module for documentation
 
-MODULE_DIR := doc
+MODULE_DIR := doc/src
 
 MANPAGES = be.1
 manpage_files = $(patsubst %,${MODULE_DIR}/%,${MANPAGES})

diff --git a/doc/tutorial b/doc/tutorial
new file mode 100644 (file)
index 0000000..1333ed7
--- /dev/null
+++ b/doc/tutorial
@@ -0,0 +1 @@
+TODO

diff --git a/setup.py b/setup.py
index 9c3c080b3c942ea4e3fdf60ced4d06ee74171ad1..2bb724c233e5a2638903fd4719a8bed4db09a285 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -21,6 +21,6 @@ setup(
               'libbe.util'],
     scripts=['be'],
     data_files=[
-        ('share/man/man1', ['doc/be.1']),
+        ('share/man/man1', ['doc/src/be.1']),
         ]
     )