tor/doc/HACKING/README.1st.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

2015-10-09 16:40:45 +02:00
In this directory
-----------------
This directory has helpful information about what you need to know to
hack on Tor!
2015-11-05 15:13:53 +01:00
First, read `GettingStarted.md` to learn how to get a start in Tor
2015-10-09 16:40:45 +02:00
development.
2015-11-05 15:13:53 +01:00
If you've decided to write a patch, `CodingStandards.txt` will give
2015-10-09 16:40:45 +02:00
you a bunch of information about how we structure our code.
2015-11-05 15:13:53 +01:00
It's important to get code right! Reading `WritingTests.md` will
2015-10-09 16:40:45 +02:00
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
2015-11-05 15:13:53 +01:00
develop the codebase: `HelpfulTools.md` can tell you how to use them
2015-10-09 16:40:45 +02:00
with Tor.
2015-11-05 15:13:53 +01:00
If it's your job to put out Tor releases, see `ReleasingTor.md` so
2015-10-09 16:40:45 +02:00
that you don't miss any steps!
-----------------------
For full information on how Tor is supposed to work, look at the files in
2015-11-05 15:13:53 +01:00
`https://gitweb.torproject.org/torspec.git/tree`.
2015-10-09 16:40:45 +02:00
For an explanation of how to change Tor's design to work differently, look at
2015-11-05 15:13:53 +01:00
`https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt`.
2015-10-09 16:40:45 +02:00
For the latest version of the code, get a copy of git, and
2015-11-05 15:13:53 +01:00
git clone https://git.torproject.org/git/tor
2015-10-09 16:40:45 +02:00
2015-11-05 15:13:53 +01:00
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
2015-10-09 16:40:45 +02:00
irc.oftc.net, with general discussion happening on #tor and development
2015-11-05 15:13:53 +01:00
happening on `#tor-dev`.
2015-10-09 16:40:45 +02:00
2015-11-05 15:13:53 +01:00
The other files in this `HACKING` directory may also be useful as you
2015-10-09 16:40:45 +02:00
get started working with Tor.
Happy hacking!
2015-11-05 15:13:53 +01:00
-----------------------
2015-10-09 16:40:45 +02:00
XXXXX also describe
doc/HACKING/WritingTests.md
2015-10-09 16:40:45 +02:00
torguts.git
torspec.git
The design paper
freehaven.net/anonbib
XXXX describe these and add links.