commit: a85da21135d7879a2b9d369d5351def4c7a023e6
parent: 448e258257054c81972dbfe017570c3e5fe82b0d
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Tue, 21 Nov 2017 19:52:42 +0100
README: Update building instructions
Diffstat:
| M | README | 37 | +++++++++++++++++++++++++------------ |
1 file changed, 25 insertions(+), 12 deletions(-)
diff --git a/README b/README
@@ -1,27 +1,40 @@
This is my utils which lives in my home PATH (~/.local/bin).
-## argc
-Currently prints number of args used. (Used for debugging some broken shells)
+# Tested and working with
+* OS: Plan9Front, */Linux, OpenBSD
+* Compilers: 9c, gcc, clang, tcc
+* Shells: ape/sh, mksh, bash
+* Quality Checks:
+ - C : LLVM scan-build, splint
+ - Shell : shellsheck
+
+# Building
+Either/one-of:
+* ``mk && mk install`` (There is ports of ``mk`` in like Plan9Port for non-Plan9 systems)
+* ``./make.sh && ./make.sh install``
-## CC-BY-SA-4.0
-License (see footer)
+# Programs and what they do
+
+## argc
+Prints number of arguments given.
## mcal
-more simple cal(1), using ISO 8601/RFC 3339 for args.
+more simple cal(1), using ISO 8601/RFC 3339 alike arguments.
+``mcal 2001 09`` instead of ``cal 09 2017``
## memsys.sh
shell script for locking then suspending to RAM under linux(and maybe others)
-## range
-A range function for C/shell.
+## seq (was named ``range``)
+Originally made one because I didn’t found ``seq``, then modified it for arguments (excluding options) compatibility with GNU seq.
## ctr (braille, morse, kirshenbaum)
CVS for tr, convertion from one CVS dictionary another using CVS
## timey-whyme.sh
-script for managing your time(TODO and Calendar), done it because todo.txt/taskwarrior didn’t have nice due time and weren’t Unix-y enough
-See example/calendar.csv and example/todo.csv for help, and put then to ``${XDG_DATA_DIR:-$HOME/.local/share}/timey-whyme/``
-
----
+Prints your todo and calendar.
+CSV is the format used because it’s simple to parse, the con is you cannot easily modify your columns (other than maybe add ones).
+See example/calendar.csv and example/todo.csv for examples, *.csv are to be stored in ``${XDG_DATA_DIR:-$HOME/.local/share}/timey-whyme/``.
-Copyright CC-BY-SA-4.0 2017- Haelwenn (lanodan) Monnier <contact@hacktivis.me>
+--
+Copyright CC-BY-SA-4.0 2017 Haelwenn (lanodan) Monnier <contact@hacktivis.me>
