aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIan Jackson <ijackson@chiark.greenend.org.uk>2023-11-07 17:17:16 +0000
committerIan Jackson <ijackson@chiark.greenend.org.uk>2023-11-07 17:22:27 +0000
commitdb3fc1550fb8b79152ca4adaa68e0e86d8eedf4c (patch)
treee9f0be86d0f37bc8c728b2e9048e2768f9eb02a7 /README.md
parent3951488cc33e96ef205835d8e9d3a13cfcda54ec (diff)
downloadtorspec-db3fc1550fb8b79152ca4adaa68e0e86d8eedf4c.tar.gz
torspec-db3fc1550fb8b79152ca4adaa68e0e86d8eedf4c.zip
Remove almost everything from top-level README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 7 insertions, 26 deletions
diff --git a/README.md b/README.md
index 95d0fe8..2581c8f 100644
--- a/README.md
+++ b/README.md
@@ -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/>