diff --git a/README.md b/README.md index 08a03ef..3d6421b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # DbPathFinder -DbPathFinder git module for use in DbSoftware (https://github.com/0xFEEDC0DE64/DbSoftware) +Small application which shows the A* path finding algorithm. + +![The demo showing pathfinding](https://raw.githubusercontent.com/0xFEEDC0DE64/DbPathFinder/master/demo.gif) + +# Building from source +This project can only be built as part of the project structure [DbSoftware](https://github.com/0xFEEDC0DE64/DbSoftware) + +```Shell +git clone https://github.com/0xFEEDC0DE64/DbSoftware.git +cd DbSoftware +git submodule update --init --recursive DbPathFinder +cd .. +mkdir build_DbSoftware +cd build_DbSoftware +qmake CONFIG+=ccache ../DbSoftware +make -j$(nproc) sub-DbPathFinder +make sub-DbPathFinder-install_subtargets +./bin/databasetree +``` diff --git a/demo.gif b/demo.gif new file mode 100644 index 0000000..60f95e2 Binary files /dev/null and b/demo.gif differ