Browse Source

update README

Damien ACCORSI 10 years ago
parent
commit
a3b8c6780d
1 changed files with 63 additions and 22 deletions
  1. 63 22
      README.md

+ 63 - 22
README.md View File

@@ -1,41 +1,81 @@
1 1
 # Introduction to TRACIM #
2 2
 
3
-Tracim is collaborative software designed to allow people to work on and share various data and document types. 
3
+Tracim is a collaborative software designed to allow people to work on and share various data and document types.
4 4
 
5
-It is [AGPL licenced](http://fr.wikipedia.org/wiki/GNU_Affero_General_Public_License) software.
5
+You hesitate to install a wiki, a forum or a file management software ? Stop hesitating: install Tracim.
6
+
7
+With Tracim, you manage in the same place:
8
+
9
+- forum-like threads,
10
+- files and automatic versionning,
11
+- wiki-like pages for online information,
12
+
13
+All data offers:
14
+
15
+- information status: open / resolved / cancelled / deprecated
16
+- native versionning
17
+- comment threads making tracim knowledge-growth-ready
18
+
19
+# Use-cases #
20
+
21
+## Collaborate with clients ##
22
+
23
+Share information with your clients.
24
+
25
+In the same place you will be able to share trouble-shooting threads, files and general information. You can define who the information is shared with.
26
+
27
+Example: share the documentation with all your clients, run a forum open to your clients, a forum for your collaborators and share troubleshooting threads with each of your clients in a private workspace.
28
+
29
+## Run a community of experts or passionate people ##
30
+
31
+Collaborate and share experience (and stimulate knowledge growth).
32
+
33
+In a unique place, you centralize files and threads, and raw information too. Every collaborator may update-the status, no worries: the traceability is at the hearth of Tracim.
34
+
35
+The newcomers knowledge growth is easy because all information has a status.
36
+
37
+## Work on quality-driven projects ##
38
+
39
+In quality-driven projects like research and development, knowledge and quality are more important that task ownership and deadlines.
40
+
41
+With Tracim, you centralize information, you can stay in touch by configuring your email notifications and work on several projects.
42
+
43
+## Manage documents and files ##
44
+
45
+Traceability and versionning is something important for quality-ready processes. Unfortunately, specialized software are hard to setup and to use. Let's try Tracim  ! You define access-control for each workspace and store documents and file there. Users can't delete information: everything is versionned and never deleted.
46
+
47
+# Licence #
6 48
 
7 49
 Tracim is licensed under the terms of the 
8
-[GNU Affero General Public License](http://www.gnu.org/licenses/agpl.txt)
9
-as published by the [Free Software Foundation](http://www.fsf.org/).
50
+[GNU Affero General Public License](http://www.gnu.org/licenses/agpl.txt) as published by the [Free Software Foundation](http://www.fsf.org/).
51
+
52
+# Technical information #
10 53
 
11
-It is currently unstable, it is recommended to use it for test purpose only.
54
+Tracim is a python 3 web application based on [TurboGears](http://www.turbogears.org/). It relies on [PostgreSQL](http://www.postgresql.org/) as storage engine.
12 55
 
13
-It's a python 3 web application based on [TurboGears](http://www.turbogears.org/); it uses [PostgreSQL](http://www.postgresql.org/) as storage engine.
56
+It runs on Debian GNU/Linux and should also work on other Linux distributions (and hopefully on BSD and Windows OSes)
14 57
 
15
-## Features ##
58
+# Give it a try #
16 59
 
17
-* Data and document sharing: text documents, files, contact, calendar, comments
18
-* Data and document status
19
-* Full traceability
20
-* Access control management, document granularity.
60
+## Online Demo ##
61
+Let's visit the online demo:
21 62
 
22
-It allows to keep private and shared data in the same place.
23
-The ACL is based on share with groups or individual users.
63
+* [http://demo.tracim.org](http://demo.tracim.org) 
64
+* login as admin: admin@admin.admin
65
+* password: admin@admin.admin
24 66
 
25
-## Give it a try ##
67
+Note: this instance is reset every day
26 68
 
27
-### Online demo ###
28
-The fastest way to test it is to test the demo:
69
+## Install your own instance ##
29 70
 
30
-* http://demo.archipeldata.com
31
-* login: demo@localhost
32
-* password: demo
71
+Following the installation documentation below, you'll be able to run your own instance on your server.
33 72
 
34
-### Install your own instance ###
73
+## Ask for a dedicated instance ##
35 74
 
36
-The other way to test it is to install it on your computer. See documentation below.
75
+You wan't to get your own instance without to manage it by yourself?
76
+Contact us at hello@trac.im
37 77
 
38
-## Installation ##
78
+# Installation #
39 79
 
40 80
 ### Dependencies###
41 81
 
@@ -135,6 +175,7 @@ conflict between system-wide python modules and tracim required ones.
135 175
     source tg2env/bin/activate
136 176
     cd tracim && python setup.py develop && cd -
137 177
     pip install -r install/requirements.txt
178
+    ./bin/tg2env-patch tg2env/
138 179
     
139 180
 Notes:
140 181