Browse code

Update and rename README to README.md

- Applying markdown format and some prettifying.
- Adding a note to arma's instruction.

Nima Fatemi authored on15/11/2014 00:40:26
Showing1 changed files
1 1
similarity index 71%
2 2
rename from README
3 3
rename to README.md
... ...
@@ -1,30 +1,32 @@
1
-To quickly get set up simply do the following...
1
+# Building website locally
2 2
 
3
-  1. Get the website's build dependencies.
3
+To quickly get set up simply do the following
4 4
 
5
-    % sudo apt-get install wml asciidoc
5
+ __Step 1:__ Get the website's build dependencies.
6 6
 
7
-  2. Configure where to find your tor git repository. It needs this to make the
7
+    sudo apt-get install wml asciidoc
8
+
9
+  __Step 2:__ Configure where to find your tor git repository. It needs this to make the
8 10
      manual page.
9 11
 
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 ]
12
+    git clone https://git.torproject.org/project/web/webwml.git
13
+    cd webwml
14
+    cp Makefile.local.sample Makefile.local
15
+    
16
+Note: Change the `TORGIT` in Makefile.local to point to your tor git repo.
14 17
 
15
-  3. Make the website.
18
+  __Step 3:__ Make the website.
16 19
 
17
-    % make
20
+    make
18 21
 
19 22
 You should now be able to point your browser at the locally generated site...
20 23
 
21
-  file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en
24
+    file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en
25
+
22 26
 
23
-Troubleshooting
27
+### Troubleshooting the build
24 28
 
25
-* The build fails with "Invalid object name".
29
+The build fails with "Invalid object name".
26 30
 
27 31
   If you get an error like...
28 32
 
... ...
@@ -35,9 +37,10 @@ Troubleshooting
35 37
 
36 38
   This means your tor repository is out of date. Update your tor git repository.
37 39
 
38
-More detailed instructions from Roger
40
+
41
+### More detailed instructions from Roger
42
+
43
+_Note: This section was written when website repo was still on svn, and it wasn't built automatically._
39 44
 
40 45
 Here are the instructions I sent David Fifield when he asked about
41 46
 editing the website. I hope they are useful for you too! --Roger