aboutsummaryrefslogtreecommitdiff
path: root/doc/HACKING/README.1st.md
diff options
context:
space:
mode:
authortom lurge <tomlurge@gmail.com>2015-11-05 09:13:53 -0500
committerNick Mathewson <nickm@torproject.org>2015-11-05 09:13:53 -0500
commit617e0f8d26449a4c51479666ce29039b901187ba (patch)
tree366612209d9bd358c07c0f3769cebabd1a122110 /doc/HACKING/README.1st.md
parent8976e739afc5e8f41a4e73bb7ce03071822535cd (diff)
downloadtor-617e0f8d26449a4c51479666ce29039b901187ba.tar.gz
tor-617e0f8d26449a4c51479666ce29039b901187ba.zip
added some markdown formatting
Diffstat (limited to 'doc/HACKING/README.1st.md')
-rw-r--r--doc/HACKING/README.1st.md28
1 files changed, 15 insertions, 13 deletions
diff --git a/doc/HACKING/README.1st.md b/doc/HACKING/README.1st.md
index a9479de097..8299fe634a 100644
--- a/doc/HACKING/README.1st.md
+++ b/doc/HACKING/README.1st.md
@@ -5,46 +5,48 @@ In this directory
This directory has helpful information about what you need to know to
hack on Tor!
-First, read 'GettingStarted.md' to learn how to get a start in Tor
+First, read `GettingStarted.md` to learn how to get a start in Tor
development.
-If you've decided to write a patch, 'CodingStandards.txt' will give
+If you've decided to write a patch, `CodingStandards.txt` will give
you a bunch of information about how we structure our code.
-It's important to get code right! Reading 'WritingTests.md' will
+It's important to get code right! Reading `WritingTests.md` will
tell you how to write and run tests in the Tor codebase.
There are a bunch of other programs we use to help maintain and
-develop the codebase: 'HelpfulTools.md' can tell you how to use them
+develop the codebase: `HelpfulTools.md` can tell you how to use them
with Tor.
-If it's your job to put out Tor releases, see 'ReleasingTor.md' so
+If it's your job to put out Tor releases, see `ReleasingTor.md` so
that you don't miss any steps!
-
-----------------------
For full information on how Tor is supposed to work, look at the files in
-https://gitweb.torproject.org/torspec.git/tree
+`https://gitweb.torproject.org/torspec.git/tree`.
For an explanation of how to change Tor's design to work differently, look at
-https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt
+`https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt`.
For the latest version of the code, get a copy of git, and
- git clone https://git.torproject.org/git/tor
+ git clone https://git.torproject.org/git/tor
-We talk about Tor on the tor-talk mailing list. Design proposals and
-discussion belong on the tor-dev mailing list. We hang around on
+We talk about Tor on the `tor-talk` mailing list. Design proposals and
+discussion belong on the `tor-dev` mailing list. We hang around on
irc.oftc.net, with general discussion happening on #tor and development
-happening on #tor-dev.
+happening on `#tor-dev`.
-The other files in this "HACKING" directory may also be useful as you
+The other files in this `HACKING` directory may also be useful as you
get started working with Tor.
Happy hacking!
+
+-----------------------
+
XXXXX also describe
doc/HACKING/WritingTests.md