millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-09-21 14:02:05 +00:00
Code Issues Releases Packages Activity

Update README.md

Browse source
This commit is contained in:
James A. Fellows Yates 2021-04-07 20:43:31 +02:00 committed by GitHub
parent 033f81734a
commit 095cd483e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -137,10 +137,10 @@ Currently documentation is available for the following systems:
[Fork](https://help.github.com/articles/fork-a-repo/) the [`nf-core/configs`](https://github.com/nf-core/configs/) repository to your own GitHub account.
Within the local clone of your fork:
* **add** the custom config file to the [`conf/`](https://github.com/nf-core/configs/tree/master/conf) directory,
* **add** the documentation file to the [`docs/`](https://github.com/nf-core/configs/tree/master/docs) directory.
* **edit** and add your custom profile to the [`nfcore_custom.config`](https://github.com/nf-core/configs/blob/master/nfcore_custom.config) file in the top-level directory of the clone.
* **edit** and add your custom profile to the [`README.md`](https://github.com/nf-core/configs/blob/master/README.md) file in the top-level directory of the clone.
* **add** the custom config file to the [`conf/`](https://github.com/nf-core/configs/tree/master/conf) directory
* **add** the documentation file to the [`docs/`](https://github.com/nf-core/configs/tree/master/docs) directory
* **edit** and add your custom profile to the [`nfcore_custom.config`](https://github.com/nf-core/configs/blob/master/nfcore_custom.config) file in the top-level directory of the clone
* **edit** and add your custom profile to the [`README.md`](https://github.com/nf-core/configs/blob/master/README.md) file in the top-level directory of the clone
In order to ensure that the config file is tested automatically with GitHub Actions please add your profile name to the `profile:` scope (under strategy matrix) in [`.github/workflows/main.yml`](.github/workflows/main.yml). If you forget to do this the tests will fail with the error: