From 617e0f8d26449a4c51479666ce29039b901187ba Mon Sep 17 00:00:00 2001 From: tom lurge Date: Thu, 5 Nov 2015 09:13:53 -0500 Subject: added some markdown formatting --- doc/HACKING/README.1st.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) (limited to 'doc/HACKING/README.1st.md') 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 -- cgit v1.2.3-54-g00ecf