aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFredrik Salomonsson <plattfot@gmail.com>2018-11-04 20:02:01 -0800
committerFredrik Salomonsson <plattfot@gmail.com>2018-11-04 20:02:01 -0800
commit4b4ec9daf5904be1e5db261d66aa63e1f377ca30 (patch)
tree9fa0245ea70c34fca18bfe91fc31f73497962c02
parente3b7083bf48a1e436ad70aa5c2984d522feb5087 (diff)
downloadpinentry-rofi-4b4ec9daf5904be1e5db261d66aa63e1f377ca30.tar.gz
Added README
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6528e0e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+
+# Description
+Based on [this gist](https://gist.github.com/sardemff7/759cbf956bea20d382a6128c641d2746)
+
+Simple pinentry gui using rofi written in GNU guile.
+
+It's similar in functionality as the gist but this one doesn't force
+the width to be 27.
+
+I also wanted a small project which I could use to practice writing
+GNU guile.
+
+# Install
+## From source
+
+```bash
+$ git clone git@github.com:plattfot/pinentry-rofi.git
+$ cd pinentry-rofi
+$ make PREFIX=<install dir>
+```
+
+Where <install dir> is where you want to install it. By default it
+will install the script in /usr/bin and the compiled source to where
+the site cache for guile is configured to.
+
+## Arch Linux
+Clone my aur reop and the build the package using the PKGBUILD:
+
+```bash
+$ git clone git@github.com:plattfot/pinentry-rofi-aur.git
+$ cd pinentry-rofi-aur
+$ makepkg -ic
+```