added a usage description to README

cem-okulmus · Nov 1, 2020 · 5ee77cd · 5ee77cd
1 parent 2ec76c2
commit 5ee77cd
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -10,4 +10,6 @@ Simply run `make`, alternatively on platforms without the make tool, run `go bui
 
 
 
-
+## Usage 
+No fixed command-line interface. Use "BalancedGo -h" to see the currently supported commands. 
+Generally, any run will require 1) a valid hypergraph, according to the formats specified above, 2) a specified width (unless the "exact" or "approx" flags are used) and 3) an algorithm to actually compute an HD or GHD (depending on the type of algorithm).