Add README

2 files changed, 65 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..2094d5b
--- /dev/null
+++ b/README
@@ -0,0 +1,63 @@
+Hydrasect
+=========
+
+Identify and prioritize commits evaluated and built by Hydra when
+bisecting Nixpkgs.  This can make the Nixpkgs bisection process much
+faster, by avoiding unnecessary rebuilds caused by testing commits in
+between Hydra evaluations, when commits built by Hydra (with build
+results in cache.nixos.org) remain to be tested.
+
+
+Installation
+------------
+
+Build dependencies:
+ - Meson
+ - Ninja
+ - rustc
+
+Runtime dependencies:
+ - Git
+ - curl
+
+In most cases, installation should be as simple as
+
+	meson build
+	ninja -C build install
+
+
+Usage
+-----
+
+The hydrasect-search program, when run in a Nixpkgs bisect, prints the
+closest commit(s) to HEAD that have been evaluated by hydra.nixos.org,
+and are yet to be tested in the bisect.
+
+So, to run a Hydra-aware Nixpkgs bisect, any time git bisect checks
+out a commit to be tested, simply run:
+
+    git checkout $(hydrasect-search | head -1)
+
+If there is a suitable Hydra commit, it will be checked out and can be
+tested instead of Git's suggestion.
+
+
+Development
+-----------
+
+The upstream git repository for Hydrasect is available at
+<https://git.qyliss.net/hydrasect/>.
+
+Bugs and patches can be sent to the author,
+Alyssa Ross <hi@alyssa.is>.
+
+For information about how to use git to send a patch email, see
+<https://git-send-email.io/>.
+
+
+License
+-------
+
+Copyright 2022 Alyssa Ross <hi@alyssa.is>
+
+Licensed under the EUPL.
diff --git a/README.license b/README.license
new file mode 100644
index 0000000..771c637
--- /dev/null
+++ b/README.license
@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+SPDX-License-Identifier: EUPL-1.2
\ No newline at end of file