[debexpo/master] Renamed README.txt to README and added notes about rst docs.
Jonny Lamb
jonny at debian.org
Fri Dec 5 16:26:04 CET 2008
Signed-off-by: Jonny Lamb <jonny at debian.org>
---
README | 11 +++++++++++
README.txt | 19 -------------------
2 files changed, 11 insertions(+), 19 deletions(-)
create mode 100644 README
delete mode 100644 README.txt
diff --git a/README b/README
new file mode 100644
index 0000000..baccfc6
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+debexpo documentation
+=====================
+
+The debexpo documentation is being stored in restructured text inside the
+docs/ directory. You can find the current installation guide at
+docs/installing.rst. You should build and view the html docs by executing:
+
+ % sudo apt-get install python-sphinx # needed to build the docs
+ % cd docs/
+ % make html
+ % sensible-browser .build/html/index.html
diff --git a/README.txt b/README.txt
deleted file mode 100644
index d44a259..0000000
--- a/README.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-This file is for you to describe the debexpo application. Typically
-you would include information such as the information below:
-
-Installation and Setup
-======================
-
-Install ``debexpo`` using easy_install::
-
- easy_install debexpo
-
-Make a config file as follows::
-
- paster make-config debexpo config.ini
-
-Tweak the config file as appropriate and then setup the application::
-
- paster setup-app config.ini
-
-Then you are ready to go.
--
1.5.6.5
More information about the debexpo-commits
mailing list