Merge branch 'hall'2.0.0

1 files changed, 35 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..1d97413
--- /dev/null
+++ b/README.org
@@ -0,0 +1,35 @@
+# -*- mode: org; coding: utf-8; -*-
+
+#+TITLE: README for Pinentry-Rofi
+
+* Description
+  Based on [[https://gist.github.com/sardemff7/759cbf956bea20d382a6128c641d2746][this gist]]
+
+  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 and doesn't depend on systemd.
+
+  I also wanted a small project which I could use to practice writing
+  GNU guile.
+
+* 2.0.0 Breaking changes please read
+
+  As of version 2.0.0, =pinentry-rofi= is now built using [[https://www.gnu.org/software/automake][automake]].
+  See [[file:HACKING][HACKING]] for more info on that. It also lost its =-guile= suffix
+  for the executable. And it is no longer just one file, most of its
+  content is now a [[https://www.gnu.org/software/guile/manual/html_node/General-Information-about-Modules.html][guile module]], which the executable now calls.
+
+* Install
+** From Source
+
+  See [[file:HACKING][HACKING]] on how to build this from source
+
+** Arch Linux
+   Clone my aur reop and the build the package using the PKGBUILD:
+
+   #+begin_src bash
+     git clone https://github.com/plattfot/pinentry-rofi-aur.git
+     cd pinentry-rofi-aur
+     makepkg -ic
+   #+end_src