Skip to content

Commit

Permalink
minor edits
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
  • Loading branch information
bentsherman committed Feb 6, 2025
1 parent 2050eb4 commit d4940f6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# nf-prov

Nextflow plugin to render provenance reports for pipeline runs. Now supporting [BioCompute Object](https://biocomputeobject.org/)!
Nextflow plugin to render provenance reports for pipeline runs. Now supporting [BioCompute Objects](https://biocomputeobject.org/)!

## Getting Started

Expand Down Expand Up @@ -92,17 +92,17 @@ mv -f settings.gradle.bkp settings.gradle
./gradlew assemble

# Launch
./launch.sh run test.nf -plugins nf-prov
./launch.sh run tests/test.nf
```

An alternative method to build and test the plugin for development purposes:

```bash
# builds the plugin .zip and copies it to the local ${HOME}/.nextflow/plugins,
# removing any pre-existing version
# build the plugin and install it to ${HOME}/.nextflow/plugins
# overwrites any previous installation with the same version
make install

# run with an externally installed nextflow using the included test workflow & config
# run with regular nextflow install
nextflow run tests/test.nf
```

Expand Down Expand Up @@ -133,6 +133,6 @@ Following these step to package, upload and publish the plugin:
./gradlew :plugins:nf-prov:upload
```

4. Create a pull request against the [nextflow-io/plugins](https://github.com/nextflow-io/plugins/blob/main/plugins.json)
project to make the plugin public accessible to Nextflow app.
4. Create a pull request against the [nextflow-io/plugins](https://github.com/nextflow-io/plugins/blob/main/plugins.json)
project to make the plugin public accessible to Nextflow app.

0 comments on commit d4940f6

Please sign in to comment.