aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-12 12:27:58 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-12 12:27:58 -0400
commit7589a207493f5a3200823bc340bccb24987b8164 (patch)
treeafcfc60a2877254411811a74b09b28b6a60e5db1 /README.md
parentf11f012f05e717bfe813e66aa19b59b3c0d1d483 (diff)
downloadtorspec-7589a207493f5a3200823bc340bccb24987b8164.tar.gz
torspec-7589a207493f5a3200823bc340bccb24987b8164.zip
Copy all verbatim items into spec directory.
Diffstat (limited to 'README.md')
-rw-r--r--README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b7ba56a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,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.
+
+
+
+
+