Add some README files for the tools

ehuss · ehuss · commit 8ce6928df2ee · 2025-12-17T18:12:18.000-08:00
diff --git a/tools/diagnostics/README.md b/tools/diagnostics/README.md
@@ -0,0 +1,3 @@
+# Diagnostics library
+
+This is an extremely basic library to provide diagnostics output for the Reference tools. It provides the ability to emit warnings or errors, and to upgrade warnings to errors via an environment variable.
diff --git a/tools/grammar/README.md b/tools/grammar/README.md
@@ -0,0 +1,3 @@
+# Grammar parser
+
+This is a library that provides a parser for the grammar rules in the Reference.
diff --git a/tools/mdbook-spec/README.md b/tools/mdbook-spec/README.md
@@ -1,5 +1,3 @@
 # mdbook-spec
 
-This is an mdbook preprocessor to add some extensions for the Rust specification.
-
-> This crate is maintained by the [rust-lang/spec](https://github.com/rust-lang/spec/) team, primarily for use by the Rust Specification and not intended for external use (except as a transitive dependency). This crate may make major changes to its APIs or be deprecated without warning.
+This is an mdbook preprocessor to add some extensions for the Rust Reference.
diff --git a/tools/style-check/README.md b/tools/style-check/README.md
@@ -0,0 +1,3 @@
+# Style check
+
+This tool checks some style and formatting rules of the Reference. This is normally run with `cargo xtask style-check`.
diff --git a/tools/xtask/README.md b/tools/xtask/README.md
@@ -0,0 +1,3 @@
+# Reference xtask
+
+This is a CLI tool to make it easier to run the tools found here in the Reference. Run `cargo xtask` to see the list of subcommands it supports.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Diagnostics library`
	`2`	`+`
	`3`	`+This is an extremely basic library to provide diagnostics output for the Reference tools. It provides the ability to emit warnings or errors, and to upgrade warnings to errors via an environment variable.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Grammar parser`
	`2`	`+`
	`3`	`+This is a library that provides a parser for the grammar rules in the Reference.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Style check`
	`2`	`+`
	`3`	+This tool checks some style and formatting rules of the Reference. This is normally run with `cargo xtask style-check`.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Reference xtask`
	`2`	`+`
	`3`	+This is a CLI tool to make it easier to run the tools found here in the Reference. Run `cargo xtask` to see the list of subcommands it supports.