fix CONTRIBUTING

yangeorget · Dec 26, 2024 · 27a4dd0 · 27a4dd0
1 parent 4036a45
commit 27a4dd0
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -43,7 +43,7 @@ NUMBA_DISABLE_JIT=1 viztracer --open -m nucs.examples.queens
 time NUMBA_CACHE_DIR=.numba/cache PYTHONPATH=. python -m nucs.examples.queens -n 12 
 ```
 
-## Package
+## Pip package
 ### How to build the package
 ```bash
 python -m build
@@ -54,4 +54,23 @@ python -m build
 python -m twine upload --verbose dist/*
 ```
 
+## Docker image
+### How to create an image
+```bash  
+docker build -t nucs .  
+```
+
+### How to tag an image
+```bash  
+docker tag nucs yangeorget/nucs:<version>   
+```
+
+### How to publish an image
+```bash  
+docker push yangeorget/nucs:<version>  
+```
 
+### How to run a container
+```bash  
+docker run -it nucs bash  
+```
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,8 +6,8 @@
 copyright = '2024, Yan Georget'
 author = 'Yan Georget'
 
-release = '4.3.1'
-version = '4.3.1'
+release = '4.4'
+version = '4.4'
 
 # -- General configuration
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name="NUCS"
-version="4.3.1"
+version="4.4"
 authors = [
   { name="Yan Georget", email="yan.georget@gmail.com" },
 ]