From 9d17aec75a3ce9999dedc7513e17c078561ec57b Mon Sep 17 00:00:00 2001 From: Friedemann Zenke Date: Thu, 27 Aug 2015 16:49:32 -0700 Subject: [PATCH] Update README.md Adds Quick start instructions --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ab67871..e2723622 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,23 @@ to simulate recurrent spiking neural networks with spike timing dependent plasticity (STDP). It comes with the GPLv3 (please see COPYING). +Quick start +----------- + +To download and compile the examples try: + +``` +sudo apt-get install cmake git build-essential libboost-all-dev +git clone https://github.com/fzenke/auryn.git && cd auryn +git checkout -b develop origin/develop +mkdir build && cd build +cmake ../ -DCMAKE_BUILD_TYPE=Release && make +``` + Documentation & Installation/Use -------------------------------- -Please visit http://www.fzenke.net/auryn/ - +Please visit the wiki at http://www.fzenke.net/auryn/ Requirements