Merge pull request #38 from ErichDonGubler/new-readmes

Mint new `README`s for `moz-webgpu-cts` and the workspace

README.md

@@ -1,20 +1,8 @@
-# `whippit`
+# `moz-webgpu-cts` workspace
 
-A (WIP) tool for working with [`web-platform-tests`] ("WPT") expectations.
+Hey there! 👋 If you're here, you're likely interested in the [`moz-webgpu-cts`
+binary]. You _might_ also be interested in the [`whippit`] library, if you want
+to build tools like `moz-webgpu-cts`.
 
-[`web-platform-tests`]: https://web-platform-tests.org/
-
-![devo-2340125260](https://github.com/ErichDonGubler/whippit/assets/658538/1f381c3d-0f43-4dfc-817c-616d3a04bdc9)
-
-Whip it _good_!
-
----
-
-## FAQ
-
-### What's the reference for this project name?
-
--   "whip it" is how WPT sounds if pronounced naively.
--   [Devo's "Whip It Good"](https://www.youtube.com/watch?v=j_QLzthSkfM) has
-    always been a favorite song in @ErichDonGubler's family.
--   That's it. 😆
+[`moz-webgpu-cts` binary]: ./moz-webgpu-cts/
+[`whippit`]: ./whippit/

moz-webgpu-cts/README.md

@@ -0,0 +1,24 @@
+# `moz-webgpu-cts`
+
+A (WIP) tool for analyzing and adjusting [Web Platform Tests] data in
+a checkout of [`mozilla-central`]. Currently tailored exclusively towards the
+WebGPU team and its use cases.
+
+[Web Platform Tests]: https://web-platform-tests.org/
+[`mozilla-central`]: https://hg.mozilla.org/mozilla-central/
+
+## Usage
+
+All of `moz-webgpu-cts`' usage documentation is embedded into its `--help` flag.
+@ErichDonGubler isn't going to try to impress you here; if you need it, see
+[installation](#Installation) and try things out yourself; if not, ask him
+directly whether this tool is interesting for you.
+
+## Installation
+
+You can install `moz-webgpu-cts` via Cargo's `install` subcommand with the
+`--git` option pointing at this repo:
+
+```sh
+cargo install --git https://github.com/ErichDonGubler/moz-webgpu-cts
+```

whippit/README.md

@@ -0,0 +1,20 @@
+# `whippit`
+
+A (WIP) library for parsing [`web-platform-tests`] ("WPT") expectations.
+
+[`web-platform-tests`]: https://web-platform-tests.org/
+
+![devo-2340125260](https://github.com/ErichDonGubler/whippit/assets/658538/1f381c3d-0f43-4dfc-817c-616d3a04bdc9)
+
+Whip it _good_!
+
+---
+
+## FAQ
+
+### What's the reference for this project name?
+
+-   "whip it" is how WPT sounds if pronounced naively.
+-   [Devo's "Whip It Good"](https://www.youtube.com/watch?v=j_QLzthSkfM) has
+    always been a favorite song in @ErichDonGubler's family.
+-   That's it. 😆