update readme

lfoppiano · Dec 25, 2023 · cc5057e · cc5057e
1 parent 5fba82e
commit cc5057e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 # Material Parsers (and other tools)
 
-Sister project of [grobid-superconductors](https://github.com/lfoppiano/grobid-superconductors) containing a web service that interfaces with the python libraries (e.g. Spacy).
+Previously this project was released as `grobid-superconductors-tools`, born as aister project of [grobid-superconductors](https://github.com/lfoppiano/grobid-superconductors) containing a web service that interfaces with the python libraries (e.g. Spacy).
 
 The service provides the following functionalities:
 
@@ -132,6 +132,8 @@ If you use our work, and write about it, please cite [our paper](https://hal.inr
 
 ## Developer's notes
 
+### Set up on Apple M1 
+
 > python -m spacy download en_core_web_sm
 
 ```shell
@@ -152,3 +154,9 @@ We need to remove tensorflow, h5py, scikit-learn from the delft dependencies in
 pip install -e ../../delft 
 ```
 
+### Release 
+
+```shall
+bump-my-version bump patch|minor|major
+```
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,10 +12,6 @@ tag_name = "v{new_version}"
 [tool.setuptools_scm]
 
 
-
-
-
-
 [project]
 name = "material-parsers"
 license = { file = "LICENSE" }