Add build instructions

[khatus.git] / README.md

diff --git a/README.md b/README.md
index ee1a6b7..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
@@ -184,10 +192,30 @@ TODO
     - snooze time (if already alerted, when to re-alert?)
     - text: subject/body
 - monitor processes
+    - totals (grand and per state)
     - zombies
+    - threads
     - CPU hogs
     - memory hogs
     - memory leaks (if some process consistently grows)
+    - is select process up?
+    - log resource usage of select processes
+- monitor arbitrary HTTP endpoint availability
+    - is status within expected range?
+    - response time
+        - is responce time within acceptable range?
+- report detailed status upon request (to a terminal)
+    - use color to indicate age of data
+- monitor logins
+    - totals (per time period)
+        - failures
+        - successes
+    - most recent
+        - success
+        - failure
+- monitor battery time remaining
+    - monitor accuracy (is percentage change rate on track to meet estimate?)
+    - adjust estimate based on observed inaccuracies in past estimates (Kalman?)
 
 Redesign notes
 --------------
@@ -207,12 +235,34 @@ 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
+      (What should that ID be? Hostname? Pub key?)
+    - fetch remote data and process locally
+    - what transport to use?
+        - ssh + rsync + cache dumps per some interval?
+    - `A` can setup self penetration testing, by setting up probe of `A` on `B`
+      and fetching results from `B` to `A`
+- offline mode - quick disable all network-using subsystems (sensors, monitors, etc)
+- classify each sensor as either "local" or "remote" (what about `iwconfig`, et al?)
 - store data with rrdtool
-- report detailed status upon request (to a terminal)
-    - use color to indicate age of data
+- some kind of personal calendar thing integration
 - monitor tracking numbers (17track should be easiest to get started with)
+- monitor password digests against known leaked password databases
 - monitor stock prices
 - monitor some item price(s) at some store(s) (Amazon, etc.)
+    - https://docs.aws.amazon.com/AWSECommerceService/latest/DG/EX_RetrievingPriceInformation.html
+    - https://docs.aws.amazon.com/AWSECommerceService/latest/DG/ReturningPrices.html
+    - https://developer.amazonservices.com/
+- monitor Amazon order status
+    - https://developer.amazonservices.com/gp/mws/api.html?group=orders&section=orders
+- monitor eBay order status
+    - http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetOrders.html
 - monitor eBay auctions (https://en.wikipedia.org/wiki/EBay_API)
 - monitor PayPal (https://www.programmableweb.com/api/paypal)
 - monitor bank account balance and transactions
@@ -264,6 +314,11 @@ Ideas
     - https://nvd.nist.gov/
     - https://vuldb.com/
     - http://cve.mitre.org/
+- vacation planning optimization
+    - I want to visit a set of places within some time period. Given the
+      current set of prices, a set of constraints (I need to stay some amount
+      of days at each, I must be in X at Y date, etc), which visiting dates for
+      each are cheapest?
 - browse https://www.programmableweb.com/ for some more ideas
 - GC trick: instead of actually doing GC, do a dummy run of building a status
   bar at `BEGIN`, to fill-in the atimes for keys we need, then use the atimes