aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEinhard Leichtfuß <alguien@respiranto.de>2018-11-29 21:40:32 +0100
committerEinhard Leichtfuß <alguien@respiranto.de>2018-11-29 21:40:32 +0100
commitfe474b95c0065907d637a247181d02818a6c763c (patch)
tree5d7f3ae84414a162adf1a3ac23c2f9466183eccc
parent8747b4a84c5062e62d31cae753ac104f241aefe4 (diff)
downloadauria-fe474b95c0065907d637a247181d02818a6c763c.tar.gz
auria-fe474b95c0065907d637a247181d02818a6c763c.tar.xz
README
-rw-r--r--README55
-rw-r--r--TODO3
2 files changed, 58 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a36c71f
--- /dev/null
+++ b/README
@@ -0,0 +1,55 @@
+README for auria - an aur helper written in (mostly) bash
+
+developement version
+
+This is unfinished software. Do not expect anything to work.
+
+
+How to use:
+-----------
+
+$ $CC parse.c -o parse
+$ ./auria.sh (update|install <pkg>|search <search_string>|rpc ...)
+
+There are configuration files, /etc/auria_conf.sh and
+$HOME/.config/auria_conf.sh, read, i.e. sourced in this order.
+Configuration can be done by setting variables used in auria.sh.
+
+
+Dependencies:
+-------------
+
+bash
+curl>=7.18.0
+coreutils (mktemp)
+diffutils
+ed (optional: default editor)
+git
+grep
+jq
+libc
+pacman
+sed
+
+
+Build dependencies:
+-------------------
+
+a C compiler
+
+
+Licensing:
+----------
+
+auria is distributed under the GNU Affero General Public License (AGPL),
+version 3. See the file COPYING for further details.
+
+
+Author:
+-------
+
+auria is written by Einhard Leichtfuß alias respiranto.
+If you have any problems, questions, suggestions or similar concerning this
+program, you may write me an email to <alguien@respiranto.de>.
+
+Remember, this is unfinished software.
diff --git a/TODO b/TODO
index 3ca8d22..9076ab8 100644
--- a/TODO
+++ b/TODO
@@ -12,3 +12,6 @@
- Consider using https://aur.archlinux.org/packages.gz
- Do something better than failing upon finding a local package not in the
repos nor the AUR.
+- color=auto (depending on where the output goes)
+- Honor PKGDEST
+ `- Option: replace `pacman -U' by `makepkg -i'