From 4ab1aab556eae06ce8b029d8ece2ef56be36bf5d Mon Sep 17 00:00:00 2001 From: vishal <95016059+gyanantaran@users.noreply.github.com> Date: Wed, 19 Jun 2024 20:25:11 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20[documentation]=20updated=20read?= =?UTF-8?q?me?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 33 +++++++++++++++++++++++++-------- requirements.txt | 4 ++++ 2 files changed, 29 insertions(+), 8 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index eecec60..2fc1653 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,36 @@ https://github.com/gyanantaran/searchViz/assets/95016059/8a3eab8e-1456-48a5-a91c Screenshot 2024-04-09 at 12 57 55 AM +## Contributions -## A Nice Demo Video +All contributions/suggestions are welcome! + +## Introduction + +Search methods are boring and fruitless untill they are visualised. Depth first search feels like a random walker on a lonely island. Breadth first search is like a stow but steady fire burning through a dense forestry. Don't believe me? See for your selves! Also, feel free to try writing your very own search methods, with the current API (not documented, only examples available inside searchViz/src/searchViz/Search.py::DFS and BFS). + +## Instructions to build the project + +```sh +cd searchViz # cd into the cloned directory +pip install -r requirements.txt # basically installs numpy and pygame +python src/main.py # run the entry-point file + +# now just press spacebar to play or pause the search for the current search-method. DFS is the default. +``` + +## Some Demo examples + +A nice and long, demo video: [![A long Walkthrough Video -- searchViz](https://github.com/gyanantaran/searchViz/assets/95016059/0de525e8-0363-47e3-87e7-8591f35fecb1)](https://youtu.be/BKF-PEgd1PA?t=393) +A short Walkthrough: + +[![Short Walkthrough Video -- searchViz](https://github.com/gyanantaran/searchViz/assets/95016059/0de525e8-0363-47e3-87e7-8591f35fecb1)](https://youtu.be/kNGsOoWh9fM?t=2) + ## Features 1. Nodes distributions can be one of a few options (gaussian, unifrom) @@ -20,10 +43,4 @@ https://github.com/gyanantaran/searchViz/assets/95016059/8a3eab8e-1456-48a5-a91c 1. Using vectorized functions in numpy -Contributions and feedbacks are welcome! - -## A short Walkthrough - -[![Short Walkthrough Video -- searchViz](https://github.com/gyanantaran/searchViz/assets/95016059/0de525e8-0363-47e3-87e7-8591f35fecb1)](https://youtu.be/kNGsOoWh9fM?t=2) - -@vishalpaudel +creative commons License, copyright, gyanantaran aka vishalpaudel 2022. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3c438c1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +numpy==2.0.0 +pygame==2.5.2 +setuptools==70.0.0 +wheel==0.43.0