Add build instructions

[khatus.git] / README.md

diff --git a/README.md b/README.md
index cc4976d..947e6ed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,6 +10,10 @@ Experimental system-monitor and status (bar) reporter I use with
 Usage
 -----
 
+`make build && make install`
+
+`make install` copies everything from `./bin` to `$HOME/bin`
+
 In my `~/.xinitrc` I have something like the following:
 
 ```sh
@@ -20,6 +24,9 @@ In my `~/.xinitrc` I have something like the following:
         -v Opt_Mpd_Song_Max_Chars=10 \
         -v Opt_Net_Interfaces_To_Show=wlp3s0 \
         -v Opt_Pulseaudio_Sink=0 \
+        -f <(./bin/khatus_gen_make_status_bar \
+                -v Status_Bar='@energy,@memory,@processes,@cpu,@disk,@net,@bluetooth,@backlight,@volume,@mpd,@weather,@datetime' \
+            ) \
     | "$BIN"/khatus_actuate_status_bar_to_xsetroot_name \
     ) \
     >(stdbuf -o L "$BIN"/khatus_monitor_energy \
@@ -168,6 +175,7 @@ controller, which are in turn actualized as desktop notifications by the
 TODO
 ----
 
+- formalize message format and protocol
 - tests (design is starting to take shape, so it is time)
 - show how many Debian package updates are available
 - show how many Debian package security-updates are available
@@ -227,6 +235,10 @@ Redesign notes
 Ideas
 -----
 
+- track devices:
+    - alert when never before seen device is plugged-in
+    - report history and trends on when and how-often each
+      device/category is plugged-in, how-long it stays plaugged-in, etc.
 - daemonize `khatus`, so we don't have to re-launch `X11` to re-launch `khatus`
 - interoperate with other khatus instances
     - prefix machine ID to each data source