README.1st 1.6 KB

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