Skip to content

Commit

Permalink
some improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
smehringer committed Mar 22, 2024
1 parent dc36e88 commit 222b293
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,35 +66,46 @@ Note: The subsequent steps, e.g., Directory Structure, are not necessary.

If you want to build an app, do the following:

0. You need to be singed in with a Github account and have a valid ssh-key to communicate with your repositories.
0. You need to be singed in with a **Github account**.

1. <details><summary> Press the `Use this template`-Button on the [Website](https://github.com/seqan/app-template) to create your **own repository**. </summary><br>

Screenshot TODO

</details>
2. Clone your repository locally: `git clone [email protected]:max/my-repo-name.git`
3. <details><summary>Adapt the project name in `my-repo-name/CMakeLists.txt`, e.g. from `app-template` to `MyDragonApp`</summary><br>

The project name is defined in these lines:

1. On this Github page, press the green `Use this template` Button on the top right corner and follow the instructions to create a new repository. Screenshot TODO
2. Clone your repository (e.g. `git clone [email protected]:max/my-repo-name.git`, check Github tutorials for more detail)
3. In your repository, adapt the project name in `my-repo-name/CMakeLists.txt`, e.g. from `app-template` to e.g. `MyDragonApp`
<details><summary>The project name is defined in these lines:</summary><br>
```cmake
project (app-template
LANGUAGES CXX
VERSION 1.0.0
DESCRIPTION "My application description"
)
```
</details>
<details><summary>Change it e.g. to this:</summary><br>

Change it e.g. to this:

```cmake
project (MyDragonApp
LANGUAGES CXX
VERSION 1.0.0
DESCRIPTION "Let dragons fly"
)
```

</details>
4. Next to your local repository clone `my-repo-name`, create a build directory and visit it: `mkdir build && cd build`
5. Run cmake: `cmake ../my-repo-name`
6. Build the application: `make`
7. Build and run the tests: `make check`
7. <details><summary>Build and run the tests: `make check` </summary><br>

Important Note: If you changed the project name, then some tests might fail because they test that name and its not `app-template` anymore.
8. execute the app: `./bin/MyDragonApp`.

</details>
8. Execute the app: `./bin/MyDragonApp`.
<!-- 8. optional: publish your tool to the galaxy toolshed, follow the example in https://github.com/SGSSGene/raptor-galaxy -->


Expand Down

0 comments on commit 222b293

Please sign in to comment.