From c4c6d942bb5284752510182689ba82b89588f381 Mon Sep 17 00:00:00 2001 From: EED85 Date: Sun, 27 Jul 2025 08:18:52 +0200 Subject: [PATCH] improve instructions --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 80aa0fd..9d9e429 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,21 @@ 1. In the EED-Solutions organization, create a new repository using this template and assign it a new name, such as `eed_my_new_package`. 2. Create a new branch (e.g., `repo_configuration`). -3. Delete the `uv.lock` file. -4. Update `project.toml` by renaming `eed-package-template` to your new package name (e.g., `eed-my-new-package`). -5. Set up a virtual environment using `uv`. -6. Install pre-commit hooks. -7. Add a note indicating the commit ID from which this repository was created, for example: +3. Rename the directory `src/eed_package_template` to match your new package name (e.g., `src/eed_my_new_package`). +4. Delete the `uv.lock` file. +5. Update `project.toml` by renaming `eed-package-template` to your new package name (e.g., `eed-my-new-package`). set version to ``0.1.0``. Update your decription. +6. Set up a virtual environment using `uv`. +7. Install pre-commit hooks. +8. Update Readme: + +Remove section ``## Creating a New Repository from This Template`` + + +Add a note indicating the commit ID from which this repository was created, for example: ``` - created from this template: https://github.com/EED-Solutions/eed_package_template/releases/tag/0.1.0 ``` -8. Rename the directory `src/eed_package_template` to match your new package name (e.g., `src/eed_my_new_package`). + 9. Use VS Code's find and replace feature to update all instances of `eed_package_template` with your new package name. 10. Commit all changes, create a pull request, and ensure all CI pipelines pass. 11. Update repository settings as needed (e.g., import branch/tag rulesets, general settings). For more information, see [this guide](https://eed-solutions.atlassian.net/wiki/x/BIA8Mw) (private access). Rulesets are documented under ``.github\rulesets`` and can be imported.