sarah
/
tor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a doc/HACKING/README.1st

This commit is contained in:
Nick Mathewson 2015-10-09 10:40:45 -04:00
parent a11cb74d29
commit 8182715a2b
3 changed files with 61 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/HACKING/GettingStarted.txt
View File

@ -192,41 +192,3 @@ Once you've reached this point, here's what you need to know.
Where do I go from here?
------------------------
More helpful resources
----------------------
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.txt
torguts.git
torspec.git
The design paper
freehaven.net/anonbib
XXXX describe these and add links.

60
doc/HACKING/README.1st Normal file
View File

@ -0,0 +1,60 @@
In this directory
-----------------
This directory has helpful information about what you need to know to
hack on Tor!
First, read 'GettingStarted.txt' 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.txt' 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.txt' can tell you how to use them
with Tor.
If it's your job to put out Tor releases, see 'ReleasingTor.txt' 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.txt
torguts.git
torspec.git
The design paper
freehaven.net/anonbib
XXXX describe these and add links.

1
doc/include.am
View File

@ -39,6 +39,7 @@ EXTRA_DIST+= doc/asciidoc-helper.sh \
doc/state-contents.txt \
doc/torrc_format.txt \
doc/TUNING \
doc/HACKING/README.1st \
doc/HACKING/CodingStandards.txt \
doc/HACKING/GettingStarted.txt \
doc/HACKING/HelpfulTools.txt \