diff options
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | README | 7 | ||||
| -rw-r--r-- | doc/spam (renamed from doc/SPAM) | 0 | ||||
| -rw-r--r-- | doc/src/be.1.sgml (renamed from doc/be.1.sgml) | 0 | ||||
| -rw-r--r-- | doc/src/module.mk (renamed from doc/module.mk) | 2 | ||||
| -rw-r--r-- | doc/tutorial | 1 | ||||
| -rwxr-xr-x | setup.py | 2 |
7 files changed, 11 insertions, 3 deletions
@@ -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 @@ -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/be.1.sgml b/doc/src/be.1.sgml index a2df21f..a2df21f 100644 --- a/doc/be.1.sgml +++ b/doc/src/be.1.sgml diff --git a/doc/module.mk b/doc/src/module.mk index 960f7c0..ea4eacc 100644 --- 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 index 0000000..1333ed7 --- /dev/null +++ b/doc/tutorial @@ -0,0 +1 @@ +TODO @@ -21,6 +21,6 @@ setup( 'libbe.util'], scripts=['be'], data_files=[ - ('share/man/man1', ['doc/be.1']), + ('share/man/man1', ['doc/src/be.1']), ] ) |