blob: b7ba56ac22a9a18d2dbd9b86dc1a9e51ec4654dd (
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# DRAFT DRAFT DRAFT
This is a demonstration, showing what the torspec.git repository
might look like after a conversion to use
[mdBook](https://rust-lang.github.io/mdBook/).
For an example of what people will see when they look at the
_rendered_ version of this repository, see
[this temporary URL](https://people.torproject.org/~nickm/volatile/mdbook-specs/index.html).
If and when we deploy this conversion, we should delete this section,
and have the rest of this document become the new `README.md`.
—nickm
------------------------------
# Tor specification repository
**IF YOU WANT TO READ THESE SPECS,
[GO HERE](https://people.torproject.org/~nickm/volatile/mdbook-specs/index.html).**
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://people.torproject.org/~nickm/volatile/mdbook-specs/index.html);
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.
|
