add readme

2 files changed, 27 insertions, 5 deletions

diff --git a/flake.nix b/flake.nix
index 3f416a9..f57d49b 100644
--- a/flake.nix
+++ b/flake.nix
@@ -47,7 +47,7 @@
         prompt = with final;
           let
             pname = "prompt";
-            packageMeta = (lib.importTOML ./bin/Cargo.toml).package;
+            packageMeta = (lib.importTOML ./Cargo.toml).package;
             rustPlatform = makeRustPlatform {
               inherit (rustChannel final) cargo rustc;
             };
@@ -56,10 +56,10 @@
             inherit pname;
             inherit (packageMeta) version;
 
-            buildInputs = [
-              final.openssl
-              final.pkgconfig
-            ];
+            nativeBuildInputs = [ pkgconfig ];
+            buildInputs = [ openssl ];
+
+            doCheck = false;
 
             src = gitignoreSource ./.;
             cargoLock.lockFile = ./Cargo.lock;
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..ed9568c
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,22 @@
+prompt
+------
+
+fast prompt helper tool to fetch vcs & cwd information, for
+use with tmux:
+
+
+   set -g  status-left "#(prompt cwd #{pane_current_path})"
+   set -ag status-left "#(prompt vcs #{pane_current_path})"
+
+
+usage
+-----
+
+    prompt cwd <some_path>
+          Compresses some_path and stripes $HOME from its
+          prefix
+
+    prompt vcs <some_path>
+          Fetches git ref (branch shorthand/commit OID),
+          repo file statuses and commit distance
+          information