commit 43377598d49ab106be6d8d13fbbceae612b6d4ac Author: Damian Johnson atagar@torproject.org Date: Fri Nov 14 08:34:04 2014 -0800
Improving the readme instructions
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 | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+)
diff --git a/README b/README index 2d66da2..80afdc5 100644 --- a/README +++ b/README @@ -1,3 +1,44 @@ +To quickly get set up simply do the following... + + 1. Get the website's build dependencies. + + % sudo apt-get install wml asciidoc + + 2. Configure where to find your tor git repository. It needs this to make the + manual page. + + % git clone https://git.torproject.org/project/web/webwml.git + % cd webwml + % cp Makefile.local.sample Makefile.local + [ change the TORGIT in Makefile.local to point to your tor git repo ] + + 3. Make the website. + + % make + +You should now be able to point your browser at the locally generated site... + + file:///home/atagar/Desktop/tor/webwml/getinvolved/volunteer.html.en + +-------------------------------------------------------------------------------- +Troubleshooting +-------------------------------------------------------------------------------- + +* The build fails with "Invalid object name". + + If you get an error like... + + ---- Contents of STDERR channel: --------- + fatal: Invalid object name 'tor-0.2.6.1-alpha'. + asciidoc: FAILED: manpage document title is mandatory + No manpage because of asciidoc error or file not available from git at /tmp/wml.zwcq0q/wml.30867.tmp1.wml line 415. + + This means your tor repository is out of date. Update your tor git repository. + +-------------------------------------------------------------------------------- +More detailed instructions from Roger +-------------------------------------------------------------------------------- + Here are the instructions I sent David Fifield when he asked about editing the website. I hope they are useful for you too! --Roger