teor eb81704081 CodingStandards: Use consistent spacing 5 年之前
..
android ca6682f3f8 Fix spelling mistakes corresponding to ticket #23650 6 年之前
design 469051f650 Copy architectural documentation from tor-guts.git repository 5 年之前
CodeStructure.md 0d6c8eed49 doc(hacking): enhance markdown style 5 年之前
CodingStandards.md eb81704081 CodingStandards: Use consistent spacing 5 年之前
CodingStandardsRust.md 0ebe290198 Removed the use of expect from CodingStandardsRust 5 年之前
EndOfLifeTor.md 3bf90e704c doc(hacking): update = to # on sections 5 年之前
Fuzzing.md 3bf90e704c doc(hacking): update = to # on sections 5 年之前
GettingStarted.md 8d913cc352 doc: make introduction paragraph point to correct data 7 年之前
GettingStartedRust.md 4847e22168 Merge branch 'maint-0.3.2' into maint-0.3.3 6 年之前
HelpfulTools.md e2512950b6 Improve failure message from check-best-practices 5 年之前
HowToReview.md aa56465934 fix typo in how-to-review guidelines 5 年之前
Maintaining.md 5dcd44cbe2 fix some of the typos in Maintaining.md 5 年之前
Module.md fa2d53aa6a Stop mentioning src/or and src/common in doc/HACKING 6 年之前
README.1st.md 617e0f8d26 added some markdown formatting 9 年之前
ReleasingTor.md 3bf90e704c doc(hacking): update = to # on sections 5 年之前
Tracing.md f720a5a439 Fix everything that previously referred to src/or 6 年之前
WritingTests.md d49133d9ca Mention that we require Python 2.7 or newer 6 年之前

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 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.