feat: add profile info

README.md

@@ -10,6 +10,7 @@ A Snakemake workflow for `<description>`
 - [Snakemake workflow: `<name>`](#snakemake-workflow-name)
   - [Usage](#usage)
   - [Deployment options](#deployment-options)
+  - [The "profiles" Directory](#the-profiles-directory)
   - [Authors](#authors)
   - [References](#references)
   - [TODO](#todo)
@@ -50,6 +51,14 @@ Run the workflow with:
 snakemake --cores 2 --sdm conda apptainer --directory .test
 ```
 
+## The "profiles" Directory
+
+When developing on a cluster or cloud instance, please include a "profiles" directory:
+
+`profiles/<cluster or cloud name>/config.yaml`
+
+This configuration file should contain the workflow profile with its resource specification for a particular execution environment (cluster or cloud). You may include a readme file next to point out pitfalls or other aspects worth a user's consideration.
+
 ## Authors
 
 - Firstname Lastname

profiles/README.txt

@@ -0,0 +1,9 @@
+A 'profiles' directory might contain workflow resource configuration for a particular cluster or cloud instance.
+
+We encourage to include a profile for your use case as:
+
+`profiles/<your cluster or cloud instance>/config.yaml`
+
+You may include a readme file next to the config.yaml file to point out pitfalls or other things to consider.
+
+We welcome pull requests for 3rd-party workflows you are working with to include such a profile! It may also be necessary to occasionally label certain rules of a particular workflow with the `localrules: <rule 1>, <rule 2>, ...` directive when workflow developers focused on server execution during development, e.g., plotting and download rules.