Skip to content

Fix typos in README.md - #6

Merged
juliendrapeau merged 4 commits into
devfrom
readme
May 8, 2026
Merged

juliendrapeau merged 4 commits into
devfrom
readme

Conversation

@juliendrapeau

@juliendrapeau juliendrapeau commented May 8, 2026 •

Copy link
Copy Markdown
Owner

This pull request updates the project to consistently use the new name simulation-project-template throughout documentation, configuration, and versioning files. It also introduces example configuration files for easier project setup and increments the project version.

Project renaming and consistency:

  • Updated references in README.md and docs/versioning.md to use simulation-project-template instead of previous names like snakemake-template or spt, including SIF container names and package installation instructions. [1] [2] [3] [4] [5]

Configuration improvements:

  • Added hpc/config_example.yaml and hpc/submit_example.yaml as templates for user configuration, with instructions to copy and customize for local use. [1] [2]
  • Renamed workflow.yaml to workflow_example.yaml and added guidance for copying and customizing it, supporting better reproducibility and user onboarding.

Version update:

  • Bumped the project version from 0.2.0 to 0.2.1 in pyproject.toml.

@github-actions

github-actions Bot commented May 8, 2026

Copy link
Copy Markdown

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
68 62 91% 90% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 0e95594 by action🐍

@juliendrapeau juliendrapeau changed the title Readme Fix typos in README.md May 8, 2026
@juliendrapeau
juliendrapeau merged commit 5cfecde into dev May 8, 2026
2 checks passed
@juliendrapeau
juliendrapeau deleted the readme branch May 8, 2026 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant