From 508a7695dae89bd2f1b03d4ec4fe951323818777 Mon Sep 17 00:00:00 2001 From: Dan Rose Date: Tue, 6 Sep 2022 16:13:53 -0500 Subject: [PATCH] Update README.md (#2349) * Update README.md Versioning instructions * Update README.md Co-authored-by: Dominik Picheta Co-authored-by: Dominik Picheta --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 19f6688..1487463 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,15 @@ contain a .nimble file, or else it will be rejected. The requirements might change in future. +## Releasing a new package version + +The version number in the directory is derived from git tags (not the `version` field in the `.nimble` script). To release a new version of a package, follow the [instructions from the Nimble readme](https://github.com/nim-lang/nimble#releasing-a-new-version): + +> * Increment the version in your ``.nimble`` file. +> * Commit your changes. +> * Tag your release, by for example running ``git tag v0.2.0``. +> * Push your tags and commits. + ## Renaming packages To rename a package you will need to add a new entry for your package. Simply