Browse Source

Documentation

Simon Vieille 2 months ago
parent
commit
acf48c4a75
No known key found for this signature in database
1 changed files with 34 additions and 34 deletions
  1. 34
    34
      README.md

+ 34
- 34
README.md View File

@@ -40,41 +40,41 @@ Requirements
40 40
 
41 41
 Git can maybe be downloaded from your system's repositories.
42 42
 
43
-	$ git config --global user.email "you@example.com"
44
-	$ git config --global user.name "Your Name"
43
+    $ git config --global user.email "you@example.com"
44
+    $ git config --global user.name "Your Name"
45 45
 
46 46
 ### Composer
47 47
 
48 48
 Composer can maybe be downloaded from your system's repositories.
49 49
 Else, follow the next instructions:
50 50
 
51
-	# With cURL
52
-	$ curl -sS https://getcomposer.org/installer | php
51
+    # With cURL
52
+    $ curl -sS https://getcomposer.org/installer | php
53 53
 
54
-	# With Wget
55
-	$ wget -O - -q https://getcomposer.org/installer | php
54
+    # With Wget
55
+    $ wget -O - -q https://getcomposer.org/installer | php
56 56
 
57
-	$ chmod +x composer.phar
57
+    $ chmod +x composer.phar
58 58
 
59
-	# For a local installation and if the envvar PATH contains "$HOME/bin/"
60
-	$ mv composer.phar ~/bin/composer
59
+    # For a local installation and if the envvar PATH contains "$HOME/bin/"
60
+    $ mv composer.phar ~/bin/composer
61 61
 
62
-	# For a global installation
63
-	$ sudo mv composer.phar /usr/local/bin/composer
62
+    # For a global installation
63
+    $ sudo mv composer.phar /usr/local/bin/composer
64 64
 
65 65
 ### Bower
66 66
 
67
-	$ sudo apt-get install npm
68
-	$ sudo npm install -g bower
67
+    $ sudo apt-get install npm
68
+    $ sudo npm install -g bower
69 69
 
70 70
 Installation
71 71
 ------------
72 72
 
73
-	$ cd /path/to/www/
74
-	$ git clone https://gitnet.fr/deblan/gist
75
-	$ cd gist
76
-	$ make
77
-	$ cp propel-dist.yaml propel.yaml
73
+    $ cd /path/to/www/
74
+    $ git clone https://gitnet.fr/deblan/gist
75
+    $ cd gist
76
+    $ make
77
+    $ cp propel-dist.yaml propel.yaml
78 78
 
79 79
 Edit `propel.yaml`. **Use spaces instead of tabulations**.
80 80
 
@@ -120,12 +120,12 @@ See the [configuration section](#configuration) for more information about confi
120 120
 
121 121
 The web server must have permission to write into `data`.
122 122
 
123
-	$ sudo chown -R www-data:www-data data
123
+    $ sudo chown -R www-data:www-data data
124 124
 
125 125
 Your webserver must be configured to serve `web/` as document root. If you use nginx, all virtual paths must be rooted with `web/index.php` or `web/app_dev.php` ([documentation](https://www.nginx.com/resources/wiki/start/topics/recipes/symfony/)). If you use apache, you must enable the `rewrite` module and restart:
126 126
 
127
-	$ sudo a2enmod rewrite
128
-	$ sudo service apache2 restart
127
+    $ sudo a2enmod rewrite
128
+    $ sudo service apache2 restart
129 129
 
130 130
 `app_dev.php` is the development router. Access is granted for an IP range defined in the same file.
131 131
 
@@ -134,8 +134,8 @@ Upgrade
134 134
 
135 135
 If your version is less than v1.4.2, run: `test -d app && git add app && git commit -m "Configuration"`.
136 136
 
137
-	$ make update
138
-	$ make propel
137
+    $ make update
138
+    $ make propel
139 139
 
140 140
 If you upgrade to v1.4.1 or more: `app/console migrate:to:v1.4.1`.
141 141
 
@@ -282,7 +282,7 @@ Response example:
282 282
         "file": "55abcfa7771e0",
283 283
         "createdAt": "2015-07-19T16:26:15Z",
284 284
         "updatedAt": "2015-07-19T16:30:15Z"
285
-		"url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/abcgi72967dd95e3461490dcaa310d728d6adef",
285
+        "url": "https:\/\/gist.deblan.org\/en\/view\/55abcfa7771e0\/abcgi72967dd95e3461490dcaa310d728d6adef",
286 286
     },
287 287
     {
288 288
         "id": 67,
@@ -292,9 +292,9 @@ Response example:
292 292
         "file": "xyzbcfa7771e0",
293 293
         "createdAt": "2015-08-19T16:26:15Z",
294 294
         "updatedAt": "2015-08-19T16:30:15Z"
295
-		"url": "https:\/\/gist.deblan.org\/en\/view\/5byzbcfa7771e0\/def72967dd95e346koq0dcaa310d728d6artu",
295
+        "url": "https:\/\/gist.deblan.org\/en\/view\/5byzbcfa7771e0\/def72967dd95e346koq0dcaa310d728d6artu",
296 296
     },
297
-	...
297
+    ...
298 298
 ]
299 299
 ```
300 300
 
@@ -386,21 +386,21 @@ Gist uses [Magallanes](http://magephp.com/) to manage deployment.
386 386
 
387 387
 **Global installation**
388 388
 
389
-	$ composer global require andres-montanez/magallanes
390
-	# if the envvar PATH contains "$HOME/bin/"
391
-	$ ln -s ~/.composer/vendor/bin/mage ~/bin/mage
389
+    $ composer global require andres-montanez/magallanes
390
+    # if the envvar PATH contains "$HOME/bin/"
391
+    $ ln -s ~/.composer/vendor/bin/mage ~/bin/mage
392 392
 
393 393
 **Local installation**
394 394
 
395
-	$ composer require andres-montanez/magallanes
395
+    $ composer require andres-montanez/magallanes
396 396
 
397 397
 There is an example of the configuration of an environment in `.mage/config/environment/prod.yml.dist`.
398 398
 
399
-	# global installation
400
-	$ mage deploy to:prod
399
+    # global installation
400
+    $ mage deploy to:prod
401 401
 
402
-	# local installation
403
-	$ ./vendor/andres-montanez/magallanes/bin/mage deploy to:prod
402
+    # local installation
403
+    $ ./vendor/andres-montanez/magallanes/bin/mage deploy to:prod
404 404
 
405 405
 Contributors
406 406
 ------------