[debexpo-devel] better README

Jonny Lamb jonnylamb at jonnylamb.com
Fri Dec 5 14:37:01 CET 2008


Hi Ondrej,

On Wed, Dec 03, 01:06:41 +0100, Ondrej Certik wrote:
> I updated the README with installation instructions, please pull from:
> 
> git clone git://github.com/certik/debexpo.git
> 
> or apply the attached patch.

Thanks for your patch! The debexpo documentation is actually 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

This should clearly be documented better. I have updated the README.txt
file to include these instructions and have attached the diff. What do
you think?

Kind regards,

-- 
Jonny Lamb, UK
jonnylamb at jonnylamb.com
-------------- next part --------------
diff --git a/README.txt b/README.txt
index d44a259..baccfc6 100644
--- a/README.txt
+++ b/README.txt
@@ -1,19 +1,11 @@
-This file is for you to describe the debexpo application. Typically
-you would include information such as the information below:
+debexpo documentation
+=====================
 
-Installation and Setup
-======================
+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:
 
-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.
+  % sudo apt-get install python-sphinx # needed to build the docs
+  % cd docs/
+  % make html
+  % sensible-browser .build/html/index.html
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: Digital signature
URL: <http://workaround.org/pipermail/debexpo-devel/attachments/20081205/5bfdf644/attachment.pgp>


More information about the debexpo-devel mailing list