From 7589a207493f5a3200823bc340bccb24987b8164 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Thu, 12 Oct 2023 12:27:58 -0400
Subject: Copy all verbatim items into spec directory.

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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.
+
+
+
+
+
-- 
cgit v1.2.3-54-g00ecf