root/branch/sphinxdoc/src/under_the_roof.rst @ 4313

Revision 4313, 1.5 kB (checked in by gpolo, 4 years ago)

Moved under_the_roof documentation to rst.

Line 
1Under Umit's Roof
2=================
3
4.. sectionauthor:: Adriano Monteiro Marques
5.. sectionauthor:: Guilherme Polo <ggpolo@gmail.com>
6
7.. warning::
8
9   This documentation is not finished! Part or all of it's content may be
10   missing or inaccurate. As Umit is under constant development and
11   improvement, expect changes in this documentation at upcoming releases.
12
13
14Configuration Files
15-------------------
16
17Umit will always try to create a $HOME/.umit configuration directory if it
18doesn't exists yet, under UNIX. Under Windows it will try to a configuration
19directory named umit under user's local application data. We call this
20configuration directory as UMIT_CFG_DIR.
21
22The steps bellow, describes how Umit is going to behave on every
23startup in order to load the configuration files:
24
25   1. Check if the location of the hardcoded paths does exist
26
27   2. Check if UMIT_CFG_DIR does exist
28
29   3. If UMIT_CFG_DIR does exist, than check the version of the files
30
31   4. If the version of the files is older than the current Umit
32      version, update the config files
33
34   5. If UMIT_CFG_DIR doesn't exist, tries to create one
35
36   6. If it is not possible to create the UMIT_CFG_DIR, then Umit will
37      use the factory-made files
38
39
40Checking out the Repository
41---------------------------
42
43Install the subversion client, and then run the command bellow::
44
45   svn co https://umit.svn.sourceforge.net/svnroot/umit
46
47
48Easter Eggs
49-----------
50
51Yes, there are easter eggs in Umit. Go find them!
Note: See TracBrowser for help on using the browser.