Nick Mathewson 2deee972a3 Merge branch 'maint-0.3.3' into maint-0.3.4 | 6 years ago | |
---|---|---|
.. | ||
android | ca6682f3f8 Fix spelling mistakes corresponding to ticket #23650 | 6 years ago |
CodingStandards.md | f7949a440f Add a CONTRIBUTING file | 6 years ago |
CodingStandardsRust.md | 03e787e220 Merge branch 'maint-0.3.3' | 6 years ago |
Fuzzing.md | 4d3310932a Small fixes to fuzzing documentation. | 7 years ago |
GettingStarted.md | 8d913cc352 doc: make introduction paragraph point to correct data | 7 years ago |
GettingStartedRust.md | 4847e22168 Merge branch 'maint-0.3.2' into maint-0.3.3 | 6 years ago |
HelpfulTools.md | 2a3998a2e8 Add Travis CI instructions. fixes #23883 | 6 years ago |
HowToReview.md | cbea334d6b Mention even more about changes files in doc/HACKING | 7 years ago |
Module.md | e12d4286bf doc: Add Module.md explaining Tor modules | 6 years ago |
README.1st.md | 617e0f8d26 added some markdown formatting | 8 years ago |
ReleasingTor.md | def2404083 typo fix in doc/HACKING/ReleasingTor | 6 years ago |
Tracing.md | ca6682f3f8 Fix spelling mistakes corresponding to ticket #23650 | 6 years ago |
WritingTests.md | 6a2a49e661 Improve docs on using gcov | 7 years ago |
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
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.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
with Tor.
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
.
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.md
torguts.git
torspec.git
The design paper
freehaven.net/anonbib
XXXX describe these and add links.