Browse Source

Merge pull request #356 from tracim/fix/337/gearbox_cmd_in_readme

Damien Accorsi 7 years ago
parent
commit
356c0ec8ca
1 changed files with 11 additions and 14 deletions
  1. 11 14
      README.md

+ 11 - 14
README.md View File

121
     git clone https://github.com/tracim/tracim.git
121
     git clone https://github.com/tracim/tracim.git
122
     cd tracim/
122
     cd tracim/
123
 
123
 
124
-*Note: Now everything is documented to be executed from the tracim directory newly created.*
125
-
126
 ## Frontend dependencies ##
124
 ## Frontend dependencies ##
127
 
125
 
128
 [//]: # ( from https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
126
 [//]: # ( from https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
157
 
155
 
158
 Install Tracim and its dependencies:
156
 Install Tracim and its dependencies:
159
 
157
 
160
-    cd tracim && python setup.py develop && cd -
161
-    pip install -r install/requirements.txt
158
+    cd tracim/
159
+    python setup.py develop
160
+    pip install -r ../install/requirements.txt
162
 
161
 
163
 ## Configuration files ##
162
 ## Configuration files ##
164
 
163
 
165
 Create configuration files for a development environment and for `WsgiDAV`:
164
 Create configuration files for a development environment and for `WsgiDAV`:
166
 
165
 
167
-    cp tracim/development.ini.base tracim/development.ini
168
-    cp tracim/wsgidav.conf.sample tracim/wsgidav.conf
166
+    cp development.ini.base development.ini
167
+    cp wsgidav.conf.sample wsgidav.conf
169
 
168
 
170
 ## Translation ##
169
 ## Translation ##
171
 
170
 
178
 The last step before running the application is to initialize the database
177
 The last step before running the application is to initialize the database
179
 schema. This is done through the following command:
178
 schema. This is done through the following command:
180
 
179
 
181
-    cd tracim && gearbox setup-app && cd -
182
-
183
-## Running the paste http server ##
180
+    gearbox setup-app
184
 
181
 
185
-    gearbox serve
182
+## Running Tracim ##
186
 
183
 
187
-While developing, the following command may be more convenient:
184
+The two parameters are optional but useful to reload the server upon code changes and to get debug data:
188
 
185
 
189
     gearbox serve --reload --debug
186
     gearbox serve --reload --debug
190
 
187
 
204
     Starting HTTP server on http://0.0.0.0:8080
201
     Starting HTTP server on http://0.0.0.0:8080
205
 
202
 
206
 You can now enter the application at
203
 You can now enter the application at
207
-[http://localhost:8080](http://localhost:8080) and login with admin user.
204
+[http://localhost:8080](http://localhost:8080) and login with admin user:
208
 
205
 
209
- * user : admin@admin.admin
210
- * password : admin@admin.admin
206
+ * user : `admin@admin.admin`
207
+ * password : `admin@admin.admin`
211
 
208
 
212
 If admin user not created yet, execute following command:
209
 If admin user not created yet, execute following command:
213
 
210