doc/HACKING/README.1st.md

   1
   2 In this directory
   3 -----------------
   4
   5 This directory has helpful information about what you need to know to
   6 hack on Tor!
   7
   8 First, read `GettingStarted.md` to learn how to get a start in Tor
   9 development.
  10
  11 If you've decided to write a patch, `CodingStandards.txt` will give
  12 you a bunch of information about how we structure our code.
  13
  14 It's important to get code right!  Reading `WritingTests.md` will
  15 tell you how to write and run tests in the Tor codebase.
  16
  17 There are a bunch of other programs we use to help maintain and
  18 develop the codebase: `HelpfulTools.md` can tell you how to use them
  19 with Tor.
  20
  21 If it's your job to put out Tor releases, see `ReleasingTor.md` so
  22 that you don't miss any steps!
  23
  24
  25 -----------------------
  26
  27 For full information on how Tor is supposed to work, look at the files in
  28 `https://gitweb.torproject.org/torspec.git/tree`.
  29
  30 For an explanation of how to change Tor's design to work differently, look at
  31 `https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt`.
  32
  33 For the latest version of the code, get a copy of git, and
  34
  35     git clone https://git.torproject.org/git/tor
  36
  37 We talk about Tor on the `tor-talk` mailing list.  Design proposals and
  38 discussion belong on the `tor-dev` mailing list.  We hang around on
  39 irc.oftc.net, with general discussion happening on #tor and development
  40 happening on `#tor-dev`.
  41
  42 The other files in this `HACKING` directory may also be useful as you
  43 get started working with Tor.
  44
  45 Happy hacking!
  46
  47
  48 -----------------------
  49
  50 XXXXX also describe
  51
  52 doc/HACKING/WritingTests.md
  53
  54 torguts.git
  55
  56 torspec.git
  57
  58 The design paper
  59
  60 freehaven.net/anonbib
  61
  62 XXXX describe these and add links.