diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 7 insertions, 26 deletions
@@ -1,31 +1,12 @@ # Tor specification repository -**IF YOU WANT TO READ THESE SPECS, -[GO HERE](https://tpo.pages.torproject.net/core/torspec/).** (It is a temporoary location; we intend to move it to `spec.torproject.org`. +This is the source code of the Tor specification documents. -This is the central location for editing and maintaining the Tor -specifications and proposals for feature changes. +**To read the Tor Specifications online**, +please go to the canonical site <https://spec.torproject.org/>. -The specification is rendered at -[better-url-here](https://tpo.pages.torproject.net/core/torspec/); -if you want to _read_ the specifications, that is the place to start. +Overview of the source code layout, and build instructions, +are in `spec/back-matter.md`. -The official site for this repository is on -[gitlab.torproject.org](https://gitlab.torproject.org/tpo/core/torspec/) - -We use mdBook to convert these specifications into the webpages you see above. -For more information about editing them, start with the -[mdBook manual]([mdBook]((https://rust-lang.github.io/mdBook/)). - -The core of this repository is: - * `spec` — A set of markdown files which contain the specifications. - The file `src/SUMAMRY.md` controls their ordering within the - rendered specification. - * `proposals` — A directory of change proposals for the Tor protocols. - -Additionally, this repository contains: - * `mdbook` — A configuration file controlling how the specifications - are rendered. - * `attic` — Obsolete specifications describing no-longer-in-use - pieces of the Tor specification, and obsolete formats of the - existing specifications. +The canonical source repository is on the Tor Project's gitab, at +<https://gitlab.torproject.org/tpo/core/torspec/> |