Skip to content

This is a template for app developers with SeqAn3. You can easily clone this repository and modify the existing code to your needs. It provides the elementary set-up for all SeqAn3 applications.

License

seqan/app-template

Repository files navigation

SeqAn3 App Template build status codecov

This is a template for app developers with SeqAn3. You can easily clone this repository and modify the existing code to your needs. It provides the elementary set-up for all SeqAn3 applications.

The example application is a FastQ to FastA file format converter. It demonstrates exemplarily the set-up of test cases, documentation, and build infrastructure. Probably you want to name your app differently — simply replace app-template with your app name in the following. Please note that the command line interface tests fail if you use an individual project name without adapting the name in the test file.

Instructions:

  1. clone this repository: git clone --recurse-submodules https://github.com/seqan/app-template.git app-template
  2. edit the project name in the project command of app-template/CMakeLists.txt
  3. create a build directory and visit it: mkdir build && cd build
  4. run cmake: cmake ../app-template
  5. build the application: make
  6. optional: build and run the tests: make test
  7. optional: build the api documentation: make doc
  8. execute the app: ./bin/app-template
  9. optional: publish your tool to the galaxy toolshed, follow the example in https://github.com/SGSSGene/raptor-galaxy

About

This is a template for app developers with SeqAn3. You can easily clone this repository and modify the existing code to your needs. It provides the elementary set-up for all SeqAn3 applications.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published