Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 2.22 KB

README.md

File metadata and controls

77 lines (56 loc) · 2.22 KB
Raw

banner

Tarsier is a collection of tools to build event-based algorithms. It is an header-only library.

install

Within a Git repository, run the commands:

mkdir -p third_party
cd third_party
git submodule add https://github.com/neuromorphic-paris/tarsier.git
git submodule update --init --recursive

user guides and documentation

User guides and code documentation are held in the wiki.

contribute

development dependencies

Debian / Ubuntu

Open a terminal and run:

sudo apt install premake4 # cross-platform build configuration
sudo apt install clang-format # formatting tool

macOS

Open a terminal and run:

brew install premake # cross-platform build configuration
brew install clang-format # formatting tool

If the command is not found, you need to install Homebrew first with the command:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Windows

Download and install:

  • Visual Studio Community. Select at least Desktop development with C++ when asked.
  • git
  • premake 4.x. In order to use it from the command line, the premake4.exe executable must be copied to a directory in your path. After downloading and decompressing premake-4.4-beta5-windows.zip, run in the command prompt:
copy "%userprofile%\Downloads\premake-4.4-beta5-windows\premake4.exe" "%userprofile%\AppData\Local\Microsoft\WindowsApps"

test

To test the library, run from the tarsier directory:

premake4 gmake
cd build
make
cd release
./tarsier

Windows users must run premake4 vs2010 instead, and open the generated solution with Visual Studio.

After changing the code, format the source files by running from the tarsier directory:

for file in source/*.hpp; do clang-format -i $file; done;
for file in test/*.cpp; do clang-format -i $file; done;

Windows users must run Edit > Advanced > Format Document from the Visual Studio menu instead.

license

See the LICENSE file for license rights and limitations (GNU GPLv3).