blob: 95d0fe89a7e056725c8fe8ffd2051572da37a935 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
# 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 central location for editing and maintaining the Tor
specifications and proposals for feature changes.
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.
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.
|
