summaryrefslogtreecommitdiff
path: root/doc/HACKING/README.1st.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2015-10-29 10:30:27 -0400
committerNick Mathewson <nickm@torproject.org>2015-10-29 10:31:38 -0400
commit92a6c578d7038556af391de23081d314091dea32 (patch)
treebc50954a35badc7c4c0b87ee35ab9c1570a13fad /doc/HACKING/README.1st.md
parente5976482a39ba28efa64764cdb19e310c84aec21 (diff)
downloadtor-92a6c578d7038556af391de23081d314091dea32.tar.gz
tor-92a6c578d7038556af391de23081d314091dea32.zip
hacking is now markdown
Not good markdown, mind you.
Diffstat (limited to 'doc/HACKING/README.1st.md')
-rw-r--r--doc/HACKING/README.1st.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/HACKING/README.1st.md b/doc/HACKING/README.1st.md
new file mode 100644
index 0000000000..3bee9ad6b2
--- /dev/null
+++ b/doc/HACKING/README.1st.md
@@ -0,0 +1,60 @@
+
+In this directory
+-----------------
+
+This directory has helpful information about what you need to know to
+hack on Tor!
+
+First, read 'GettingStarted.txt' to learn how to get a start in Tor
+development.
+
+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.txt' 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.txt' can tell you how to use them
+with Tor.
+
+If it's your job to put out Tor releases, see 'ReleasingTor.txt' 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
+
+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
+
+For the latest version of the code, get a copy of git, and
+
+ 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
+irc.oftc.net, with general discussion happening on #tor and development
+happening on #tor-dev.
+
+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.txt
+
+torguts.git
+
+torspec.git
+
+The design paper
+
+freehaven.net/anonbib
+
+XXXX describe these and add links.