Pārlūkot izejas kodu

upgrade documentation with pgtool

Damien ACCORSI 10 gadus atpakaļ
vecāks
revīzija
831c535524
1 mainītis faili ar 27 papildinājumiem un 11 dzēšanām
  1. 27 11
      README.md

+ 27 - 11
README.md Parādīt failu

1
 # Tracim - Introduction #
1
 # Tracim - Introduction #
2
 
2
 
3
-Tracim is a 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 share and work on various data and document types.
4
 
4
 
5
-You hesitate to install a wiki, a forum or a file management software ? Stop hesitating: install Tracim.
5
+If you hesitate to install a wiki, a forum or a file management software, stop hesitating and install Tracim.
6
 
6
 
7
 With Tracim, you manage in the same place:
7
 With Tracim, you manage in the same place:
8
 
8
 
14
 
14
 
15
 - information status: open / resolved / cancelled / deprecated
15
 - information status: open / resolved / cancelled / deprecated
16
 - native versionning
16
 - native versionning
17
-- comment threads making tracim knowledge-growth-ready
17
+- comment threads making tracim knowledge-growth ready.
18
 
18
 
19
 ## Use-cases ##
19
 ## Use-cases ##
20
 
20
 
24
 
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.
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
 
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.
27
+Example: share the documentation with all your users, run a forum open to your clients, another forum for your collaborators and share troubleshooting threads with each of your clients in a private workspace.
28
 
28
 
29
 ### Run a community of experts or passionate people ###
29
 ### Run a community of experts or passionate people ###
30
 
30
 
31
-Collaborate and share experience (and stimulate knowledge growth).
31
+Collaborate and share experience and stimulate knowledge growth.
32
 
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.
33
+In a unique place, you centralize files and threads, and raw information too. Every collaborator can update the information status.
34
+Stop worrying about information loss: the traceability is at the hearth of Tracim.
34
 
35
 
35
-The newcomers knowledge growth is easy because all information has a status.
36
+The newcomers knowledge growth is easy because all information has a status and full history.
37
+You get the status of information and know how it got there.
36
 
38
 
37
 ### Work on quality-driven projects ###
39
 ### Work on quality-driven projects ###
38
 
40
 
42
 
44
 
43
 ### Manage documents and files ###
45
 ### Manage documents and files ###
44
 
46
 
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.
47
+Traceability and versionning are very important for high-quality processes. Unfortunately, specialized software are hard to setup and to use.
48
+
49
+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.
50
+
51
+The user interface is easy to use: it's based on the well-known folders and files explorer paradigm.
46
 
52
 
47
 ----
53
 ----
48
 
54
 
55
 
61
 
56
 ## Technical information ##
62
 ## Technical information ##
57
 
63
 
58
-Tracim is a web application :
64
+Tracim is a web application:
59
 
65
 
60
 * developed with python 3.
66
 * developed with python 3.
61
 * based on the [TurboGears](http://www.turbogears.org/) web framework.
67
 * based on the [TurboGears](http://www.turbogears.org/) web framework.
62
 * relying on [PostgreSQL](http://www.postgresql.org/) as the storage engine.
68
 * relying on [PostgreSQL](http://www.postgresql.org/) as the storage engine.
63
 
69
 
70
+The user interface is based on the following resources and technologies:
71
+
72
+* [Mako](http://www.makotemplates.org/) templating engine (server-side)
73
+* [Bootstrap 3](http://getbootstrap.com/)
74
+* [jQuery](http://wwwjquery.corm)
75
+* Icons are taken from [Tango Icons](http://tango.freedesktop.org/) and [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
76
+* The design is based on the [Bootstrap dashboard example](http://getbootstrap.com/examples/dashboard/) and uses some images from [Start Boostrap free templates](http://startbootstrap.com/)
77
+
78
+
79
+
64
 It runs on [Debian GNU/Linux](http://www.debian.org/), it should work out-of-the-box on [Ubuntu](http://www.ubuntu.com/) and also on other GNU/Linux distributions.
80
 It runs on [Debian GNU/Linux](http://www.debian.org/), it should work out-of-the-box on [Ubuntu](http://www.ubuntu.com/) and also on other GNU/Linux distributions.
65
 
81
 
66
 Hopefully it works on BSD and Windows OSes (but this has not been tested yet)
82
 Hopefully it works on BSD and Windows OSes (but this has not been tested yet)
337
         LogLevel debug
353
         LogLevel debug
338
     </VirtualHost>
354
     </VirtualHost>
339
 
355
 
340
-## Support ##
356
+# Support and Community #
341
 
357
 
342
-### Community - Need help ? ###
358
+## Need help ? ##
343
 
359
 
344
 Building the community is a work in progress.
360
 Building the community is a work in progress.
345
 
361