nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 12:23:32 +01:00
Code Issues Packages Projects Releases Wiki Activity
27d6b3ae7a
tor/doc/HACKING
History
Emily Bones 33e2c5962c Add links to original design paper and anonbib 
Closes #33742
2021-06-07 20:33:15 +00:00
..
android Syntax highlighting in the docs 2020-07-13 11:45:14 +02:00
tracing Fix typos. 2020-11-12 11:44:09 -05:00
CircuitPaddingDevelopment.md Update remaining trac.tpo wiki urls 2020-09-14 11:02:38 -04:00
CircuitPaddingQuickStart.md Revise trac.torproject.org urls to refer to gitlab replacements. 2020-08-14 09:21:28 -04:00
CodingStandards.md Rewrite documentation on primary branch usage for Tor.git. 2021-05-25 00:20:46 +00:00
CodingStandardsRust.md Merge branch 'maint-0.4.4' 2020-07-13 10:45:04 -04:00
Fuzzing.md Revise trac.torproject.org urls to refer to gitlab replacements. 2020-08-14 09:21:28 -04:00
GettingStarted.md Rewrite documentation on primary branch usage for Tor.git. 2021-05-25 00:20:46 +00:00
GettingStartedRust.md Fix typos. 2020-11-12 11:44:09 -05:00
HelpfulTools.md Rewrite documentation on primary branch usage for Tor.git. 2021-05-25 00:20:46 +00:00
HowToReview.md doc: Replace "underline" with "## Section name". 2020-03-26 16:19:42 +01:00
Maintaining.md Rewrite documentation on primary branch usage for Tor.git. 2021-05-25 00:20:46 +00:00
Module.md Syntax highlighting in the docs 2020-07-13 11:45:14 +02:00
README.1st.md Add links to original design paper and anonbib 2021-06-07 20:33:15 +00:00
ReleaseSeriesLifecycle.md Rewrite documentation on primary branch usage for Tor.git. 2021-05-25 00:20:46 +00:00
ReleasingTor.md Add a checklist to releasingtor.md 2021-06-07 13:51:05 -04:00
WritingTests.md WritingTests.md: add a section about shells 2020-07-28 22:59:47 -04:00

README.1st.md

README.1st

In this directory

This directory has helpful information about what you need to know to hack on Tor!

First, read GettingStarted.md and GettingStartedRust.md to learn how to get a start in Tor development.

If you've decided to write a patch, CodingStandards.md and CodingStandardsRust.md will give you a bunch of information about how we structure our code.

It's important to get the 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!

Additional Information

For full information on how Tor is supposed to work, look at the files in Tor specification.

For an explanation of how to change Tor's design to work differently, look at the Tor proposal process.

For the latest version of the code, get a copy of git, and

$ git clone https://git.torproject.org/git/tor

For a copy of Tor's original design paper, see here. Note that Tor has changed in many ways since 2004.

For a large collection of security papers, many of which are related to Tor, see Anonbib's Selected Papers in Anonymity.

Stay in touch

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!