From 0ea46a3d721bdefab70f24c4c5573ff568a56cab Mon Sep 17 00:00:00 2001 From: Simponic Date: Thu, 10 Dec 2020 18:10:51 -0700 Subject: Added files --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b0fb7d5..f35c33f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# graph-explorer +# Graph Explorer This is a WOK (wealth of knowledge) explorer that I made for fun and profit for CSE280. + +## Installation + +All you need is pygame! + +```bash +pip install pygame +``` + +## Usage +```bash +python3 main.py +``` +Select a node by clicking it; this will focus the links that are directed out of that node. + +Press "P" to select all nodes. + +Press "F" to find a node (this is done as a prompt in the shell). + +Press "Space" to pause the visualization. + +Press "C" to clear all the selected nodes. + + +## Using the WOK Builder + +```bash +python3 builder.py +``` + +The builder is a simple one; click anywhere where there is not a node to create a new one (prompted in terminal). + +You can add links between nodes by selecting first the source node and then the directed node. A description for the link will be prompted in the terminal. + +If you accidentally link two nodes, you can cancel the link by typing "no" in the description. + +Press "F" to search for a node. If found, this node will turn blue. -- cgit v1.2.3-70-g09d2