README: add recipe for how to update mpdecimal sources

erlend-aasland · erlend-aasland · commit 5110f51f5d59 · 2024-02-08T09:58:02.000+01:00
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# cpython-source-deps
-Source for packages that the cpython build process depends on
+# The mpdecimal source code
+
+How to update the mpdecimal source code in this branch:
+
+1. Dowload the new sources in tar.gz format from the
+   [mpdecimal download page](https://www.bytereef.org/mpdecimal/download.html).
+
+2. Validate the SHA256 checksum of the downloaded file.
+
+3. Unpack the source code and commit the changes:
+
+   ```console
+   # Example with mpdecimal version 4.0.0
+   $ git commit -am "Add mpdecimal 4.0.0 sources"
+   ```
+
+5. Tag the new commit:
+
+   ```
+   $ git tag -sam "mpdecimal 4.0.0" mpdecimal-4.0.0
+   ```
+
+6. Push changes, including tags, upstream.
