tor-webwml.git

Update README.md
Parent 08bc424e6
Nima Fatemi

Nima Fatemi commited on 2014-11-17 02:26:43
Zeige 1 geänderte Dateien mit 18 Einfügungen und 9 Löschungen. 

wrapping the text at 79 chars per line
README.md
Zeige Datei @ e547d2e21
... ... 
@@ -1,13 +1,15 @@
1 1 
 # How to contribute
2 2
3 
-Thanks for being interested to work on the website, I tried to make a simple how-to for you to quickly get you setup:
3 
+Thanks for being interested to work on the website, I tried to make a simple
4 
+how-to for you to quickly get you setup:
4 5
5 6 
 __Step 1:__ Clone the git repo.
6 7
7 8 
     git clone https://git.torproject.org/project/web/webwml.git
8 9 
     cd webwml
9 10
10 
-__Step 1b:__ Create a bare public repository (i.e on Github), where you'd push your commits to. Make sure you're in `webwml` directory, and run:
11 
+__Step 1b:__ Create a bare public repository (i.e on Github), where you'd push
12 
+your commits to. Make sure you're in `webwml` directory, and run:
11 13
12 14 
     git remote add pick-a-name your-git-url
13 15
... ... 
@@ -16,17 +18,20 @@ _Example:_
16 18
17 19 
 __Step 2:__ Create and switch to a new branch.
18 20
19 
-_In the following example, I've named my branch "docs" as I'm planning to work on the documentations._
21 
+_In the following example, I've named my branch "docs" as I'm planning to work
22 
+on the documentations._
20 23
21 24 
     git checkout -b docs
22 25
23 
-__Step 3:__ Now you can start working on website and make changes. Once you're done, commit and push it to your public repo.
26 
+__Step 3:__ Now you can start working on website and make changes. Once you're
27 
+done, commit and push it to your public repo.
24 28
25 29 
 _Example:_
26 30
27 31 
     git push tpo-gh docs
28 32
29 
-__Step 4:__ Open a new ticket on [trac](https://trac.torproject.org) with a link to your shiny new repo/branch.
33 
+__Step 4:__ Open a new ticket on [trac](https://trac.torproject.org) with a
34 
+link to your shiny new repo/branch.
30 35
31 36 
 # Building website
32 37 
 Torproject website is being built and published automatically.
... ... 
@@ -36,7 +41,8 @@ To quickly get set up and build website locally, simply follow these steps:
36 41
37 42 
     sudo apt-get install wml asciidoc
38 43
39 
-  __Step 2:__ Configure where to find your tor git repository. It needs this to make the
44 
+  __Step 2:__ Configure where to find your tor git repository. It needs this
45 
+to make the
40 46 
      manual page.
41 47
42 48 
     git clone https://git.torproject.org/project/web/webwml.git
... ... 
@@ -63,14 +69,17 @@ The build fails with "Invalid object name".
63 69 
     ---- Contents of STDERR channel: ---------
64 70 
     fatal: Invalid object name 'tor-0.2.6.1-alpha'.
65 71 
     asciidoc: FAILED: manpage document title is mandatory
66 
-    No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.
72 
+    No manpage because of asciidoc error or file not available from git at
73 
+    /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415.
67 74
68 
-  This means your tor repository is out of date. Update your tor git repository.
75 
+  This means your tor repository is out of date. Update your tor git
76 
+repository.
69 77
70 78
71 79 
 ### More detailed instructions from Roger
72 80
73 
-_Note: This section was written when website repo was still on svn, and it wasn't built automatically._
81 
+_Note: This section was written when website repo was still on svn, and it
82 
+wasn't built automatically._
74 83
75 84 
 Here are the instructions I sent David Fifield when he asked about
76 85 
 editing the website. I hope they are useful for you too! --Roger
77 86