nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-09-21 13:34:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
fd6a35eb59
tor/doc/HACKING
History
Bartosz Duszel fd6a35eb59 Update README files with common style. 
- external links use markdown's []() format,
- local files are formated with backquotes,
- duplicated new lines were removed,
- unnecesary single spaces were removed,
- broken links and local paths were updated.
2020-03-22 13:50:58 +01:00
..
android Fix spelling mistakes corresponding to ticket #23650 2018-02-07 10:41:57 -05:00
CircuitPaddingDevelopment.md Add NSF support acknowledgment to circpad dev doc. 2019-12-17 17:10:40 -06:00
CircuitPaddingQuickStart.md Add circuit padding developer and quickstart docs. 2019-12-16 22:00:54 +02:00
CodeStructure.md doc(hacking): enhance markdown style 2019-08-21 16:22:08 +02:00
CodingStandards.md Update README files with common style. 2020-03-22 13:50:58 +01:00
CodingStandardsRust.md Update README files with common style. 2020-03-22 13:50:58 +01:00
EndOfLifeTor.md doc(hacking): update = to # on sections 2019-08-21 16:22:37 +02:00
Fuzzing.md doc(hacking): update = to # on sections 2019-08-21 16:22:37 +02:00
GettingStarted.md Update README files with common style. 2020-03-22 13:50:58 +01:00
GettingStartedRust.md Update README files with common style. 2020-03-22 13:50:58 +01:00
HelpfulTools.md go in to fix one typo, end up fixing more 2020-02-03 23:21:58 -05:00
HowToReview.md fix typo in how-to-review guidelines 2019-10-07 00:48:11 -04:00
Maintaining.md fix some of the typos in Maintaining.md 2019-02-17 16:55:55 -05:00
Module.md Define a "dircache" module. 2020-01-16 07:48:17 -05:00
README.1st.md Update README files with common style. 2020-03-22 13:50:58 +01:00
ReleasingTor.md Update README files with common style. 2020-03-22 13:50:58 +01:00
Tracing.md Fix everything that previously referred to src/or 2018-07-05 17:15:50 -04:00
WritingTests.md Update README files with common style. 2020-03-22 13:50:58 +01:00

README.1st.md

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

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!

TODO

XXXXX also describe

doc/HACKING/WritingTests.md

torguts.git

torspec.git

The design paper

freehaven.net/anonbib

XXXX describe these and add links.