Improving the readme instructions
Damian Johnson commited on 2014-11-14 17:34:04
Zeige 1 geänderte Dateien mit 41 Einfügungen und 0 Löschungen.
Roger's instructions were nice, but they were still a wall of text. When I run into a readme I want it to help me get things set up quickly. As such, adding brief setup instrucions and a troubleshooting section. Roger's instructions were also missing the ascidoc dependency.
- README 2d66da2df..80afdc5e4
| ... | ... |
@@ -1,3 +1,44 @@ |
| 1 |
+To quickly get set up simply do the following... |
|
| 2 |
+ |
|
| 3 |
+ 1. Get the website's build dependencies. |
|
| 4 |
+ |
|
| 5 |
+ % sudo apt-get install wml asciidoc |
|
| 6 |
+ |
|
| 7 |
+ 2. Configure where to find your tor git repository. It needs this to make the |
|
| 8 |
+ manual page. |
|
| 9 |
+ |
|
| 10 |
+ % git clone https://git.torproject.org/project/web/webwml.git |
|
| 11 |
+ % cd webwml |
|
| 12 |
+ % cp Makefile.local.sample Makefile.local |
|
| 13 |
+ [ change the TORGIT in Makefile.local to point to your tor git repo ] |
|
| 14 |
+ |
|
| 15 |
+ 3. Make the website. |
|
| 16 |
+ |
|
| 17 |
+ % make |
|
| 18 |
+ |
|
| 19 |
+You should now be able to point your browser at the locally generated site... |
|
| 20 |
+ |
|
| 21 |
+ file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en |
|
| 22 |
+ |
|
| 23 |
+-------------------------------------------------------------------------------- |
|
| 24 |
+Troubleshooting |
|
| 25 |
+-------------------------------------------------------------------------------- |
|
| 26 |
+ |
|
| 27 |
+* The build fails with "Invalid object name". |
|
| 28 |
+ |
|
| 29 |
+ If you get an error like... |
|
| 30 |
+ |
|
| 31 |
+ ---- Contents of STDERR channel: --------- |
|
| 32 |
+ fatal: Invalid object name 'tor-0.2.6.1-alpha'. |
|
| 33 |
+ asciidoc: FAILED: manpage document title is mandatory |
|
| 34 |
+ No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415. |
|
| 35 |
+ |
|
| 36 |
+ This means your tor repository is out of date. Update your tor git repository. |
|
| 37 |
+ |
|
| 38 |
+-------------------------------------------------------------------------------- |
|
| 39 |
+More detailed instructions from Roger |
|
| 40 |
+-------------------------------------------------------------------------------- |
|
| 41 |
+ |
|
| 1 | 42 |
Here are the instructions I sent David Fifield when he asked about |
| 2 | 43 |
editing the website. I hope they are useful for you too! --Roger |
| 3 | 44 |
|
| 4 | 45 |