tazbug rev 0

Initial commit with the README
author Christophe Lincoln <pankso@slitaz.org>
date Tue Apr 03 11:38:28 2012 +0200 (2012-04-03)
parents
children 4c0eb28fc0a4
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Apr 03 11:38:28 2012 +0200
     1.3 @@ -0,0 +1,49 @@
     1.4 +TazBug - The SliTaz Bug Tracker
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +The SliTaz Project have setup and tried several bug trackers but ther wher never
     1.9 +adopted by the main developers. This is an attemp to change that by providong
    1.10 +a radicaly simple tool well integrated wirh SliTaz packages Cooker, Cookiso,
    1.11 +Roadmap and other sites such as the wiki and forum.
    1.12 +
    1.13 +Users data are securely stored outside of the web server document root. Password
    1.14 +are crypted with MD5 and also stored outside of the document root. Your ID key
    1.15 +is the MD5 sum of your login, mail and password
    1.16 +
    1.17 +TazBug is simple to use, 2 type of status exist: OPEN and CLOSED and 4 priority
    1.18 +level are handled. Affected packages name can be added to the bug and the all
    1.19 +bug configuration file can be edited.
    1.20 +
    1.21 +
    1.22 +TazBug Goals
    1.23 +------------
    1.24 +
    1.25 +	* Simple to use with a clean and modern interface
    1.26 +	* Client side cmdline tool to post bugs and messages
    1.27 +	* Full desktop integration with GTK boxes or local CGI script
    1.28 +	* Use http://paste.slitaz.org/ for attached files
    1.29 +	* Use shared accounts with other sites to have only one login
    1.30 +
    1.31 +
    1.32 +Installation
    1.33 +------------
    1.34 +TazBug should work on any SliTaz system and can be used as a Bug Tracker for
    1.35 +your project. You can grab last source from SliTaz Mercurial repositories or
    1.36 +a release tarball from SliTaz mirrors. You need a web server with CGI support
    1.37 +and SliTaz httphelp in /usr/lib/slitaz as well as Busybox HTTPd applet.
    1.38 +
    1.39 +People config files: /var/lib/slitaz/people
    1.40 +Auth file with pass: /var/lib/slitaz/auth/people
    1.41 +
    1.42 +
    1.43 +Developement
    1.44 +------------
    1.45 +Shell scripts as usual, HTML 5, CSS 3 and a bit of Javascript. To work on bugs
    1.46 +locally you have to clone the repo, create a vhost for the web interface and
    1.47 +modify tazbug.conf to match your installation. You must also edit /etc/hosts
    1.48 +to add your vhost.
    1.49 +
    1.50 +
    1.51 +================================================================================
    1.52 +