diff --git a/README.md b/README.md index 49f2140..7102846 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # DbNeuralNet -DbNeuralNet git module for use in DbSoftware (https://github.com/0xFEEDC0DE64/DbSoftware) +Small library to define and execute a neural net with back propagation. The example applications tries to learn XOR operations. + +# 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 DbNeuralNet +cd .. +mkdir build_DbSoftware +cd build_DbSoftware +qmake CONFIG+=ccache ../DbSoftware +make -j$(nproc) sub-DbNeuralNet +make sub-DbNeuralNet-install_subtargets +./bin/databasetree +```