changeset 253:7effcce03192

docs update, developments serves statics as default
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 04 Jun 2010 13:22:54 +0200
parents 3782a6d698af
children 85cbe7ad3402
files README.rst README.txt development.ini
diffstat 3 files changed, 43 insertions(+), 36 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Fri Jun 04 13:22:54 2010 +0200
@@ -0,0 +1,42 @@
+------------
+Pylons based replacement for hgwebdir
+------------
+
+Fully customizable, with authentication, permissions. Based on vcs library.
+**Owerview**
+- has it's own middleware to handle mercurial protocol request each request can
+  be logged and authenticated + threaded performance unlikely to hgweb
+- mako templates let's you cusmotize look and feel of appplication.
+- diffs annotations and source code all colored by pygments.
+- admin interface for performing user/permission managments as well as repository
+  managment
+- added cache with invalidation on push/repo managment for high performance and
+  always upto date data.
+- rss /atom feed customizable
+- future support for git
+- based on pylons 1.0 / sqlalchemy 0.6
+
+
+**Incoming**
+- full permissions per project
+- setup project descriptions and info into db
+- git support (when vcs can handle it)
+
+.. note::
+   This software is still in beta mode. I don't guarantee that it'll work.
+   
+
+-------------
+Installation
+-------------
+ - create new virtualenv and activate it
+ - download hg app and run python setup.py install 
+ - goto build/ directory
+ - goto pylons_app/lib and run python db_manage.py it should create all 
+   needed tables and an admin account. 
+ - edit file repositories.config and change the [paths] where you keep your
+   mercurial repositories, remember about permissions for accessing this dir by
+   hg app.
+ - run paster serve development.ini 
+   the app should be available at the 127.0.0.1:5000
+ - use admin account you created to login.   
\ No newline at end of file
--- a/README.txt	Fri Jun 04 13:08:29 2010 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,35 +0,0 @@
-Pylons based replacement for hgwebdir. Fully customizable, 
-with authentication, permissions. Based on vcs library.
-- has it's own middleware to handle mercurial protocol request each request can
-  be logged and authenticated +threaded performance unlikely to hgweb
-- mako templates let's you cusmotize look and feel of appplication.
-- diffs annotations and source code all colored by pygments.
-- admin interface for performing user/permission managments as well as repository
-  managment
-- added cache with invalidation on push/repo managment for high performance and
-  always upto date data.
-- rss /atom feed customizable
-- future support for git
-- based on pylons 1.0 / sqlalchemy 0.6
-
-===
-This software is still in beta mode. I don't guarantee that it'll work.
-I started this project since i was tired of sad looks, and zero controll over
-our company regular hgwebdir.
-
-
-== INSTALATION
- - create new virtualenv,
- - run python setup.py install
- - goto build/ directory
- - goto pylons_app/lib and run python db_manage.py it should create all 
-   needed tables and an admin account. 
- - Edit file repositories.config and change the [paths] where you keep your
-   mercurial repositories, remember about permissions for accessing this dir by
-   hg app.
- - run paster serve production.ini 
-   the app should be available at the 127.0.0.1:8001, the static files should be
-   missing since in production.ini sets static_files = false change it to true
-   for serving static files in hg app, but i highly recommend to serve 
-   statics by proxy (nginx or similar).
- - use admin account you created to login.   
\ No newline at end of file
--- a/development.ini	Fri Jun 04 13:08:29 2010 +0200
+++ b/development.ini	Fri Jun 04 13:22:54 2010 +0200
@@ -35,7 +35,7 @@
 [app:main]
 use = egg:pylons_app
 full_stack = true
-static_files = false
+static_files = true
 lang=en
 cache_dir = %(here)s/data
 ##a name for our application