Skip to content

Commit

Permalink
Merge pull request #76 from seqan/doc/readme
Browse files Browse the repository at this point in the history
[DOC] Update README.md
  • Loading branch information
eseiler authored Mar 4, 2024
2 parents 006c26f + 66efaf6 commit 2d6439a
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,15 @@ Probably you want to name your app differently — simply replace `app-template`
Please note that the command line interface tests fail if you use an individual project name without adapting the
name in the test file.

For requirements, check the [Software section of the SeqAn3 Quick Setup](https://docs.seqan.de/seqan3/main_user/setup.html#autotoc_md109).
Note: The subsequent steps, e.g., Directory Structure, are not necessary.

## 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`
1. clone this repository: `git clone https://github.com/seqan/app-template.git`
2. Optional: 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
6. optional: build and run the tests: `make check`
7. execute the app: `./bin/app-template`, or the new project name you set in 2 (`./bin/my_project`).
8. optional: publish your tool to the galaxy toolshed, follow the example in https://github.com/SGSSGene/raptor-galaxy

0 comments on commit 2d6439a

Please sign in to comment.