Update Readme and contributing files

README.md

@@ -2,22 +2,21 @@
 
 This repository contains a [cookiecutter](https://github.com/cookiecutter/cookiecutter) template 
 that can be used for library development. The template contains several well-known "best-practices" for libraries
- (tox, sphinx, nbsphinx, coverage, pylint etc) and also some tools 
+ (mypy, ruff, sphinx, nbsphinx, coverage, pylint etc) and also some tools 
 inspired by projects of ours that we consider generally useful - build and release scripts,
 auto-generation of documentation files, links for jumping directly to the correct place in the source code and others.
 Earlier versions of this template were used in several industry projects as well as for open source libraries.
 
-Build, install and tests of the library are run by tox, the documentation is built with sphinx and a
-helper script (both also invoked by tox). The template includes ci/cd pipelines for gitlab CI, github actions and
-a rudimentary pipeline for azure devops. The pipeline will run the test suite and publish docu, badges and reports. On
-gitlab, [gitlab pages](https://docs.gitlab.com/ee/user/project/pages/) are used and on github, 
-we make use of [github pages](https://pages.github.com/) through the 
-[github-pages-deploy-action](https://github.com/JamesIves/github-pages-deploy-action). You will need to enable pages 
-for gitlab, for github you should configure the pages source to be the root directory of the branch gh-pages.
+Build, install and tests of the library are run by default poetry tasks, the documentation is built with Jupyter-Books.
+The template includes ci/cd pipelines for github actions and a rudimentary pipeline for azure devops. 
+The pipeline will run the test suite and publish docu, badges and reports. 
+We make use of [github pages](https://pages.github.com/) through the [github-pages-deploy-action](https://github.com/JamesIves/github-pages-deploy-action). 
+You should configure the pages source to be the root directory of the branch gh-pages.
 
 In the documentation links to source code will be created, therefore you will be prompted to give the project's url.
 
-See the resulting repository's [developer's readme]({{cookiecutter.project_name}}/CONTRIBUTING.md) for further details. An example of the current output of this template is in [pymetrius_output](https://github.com/appliedAI-Initiative/pymetrius_output)
+See the resulting repository's [developer's readme]({{cookiecutter.project_name}}/docs/04_contributing/04_contributing.rst) 
+for further details. An example of the current output of this template is in [pymetrius_output](https://github.com/appliedAI-Initiative/pymetrius_output)
 
 # Usage
 
@@ -41,8 +40,8 @@ and walk through the questions. You can also clone this repository, adjust the t
 the local file.
 
 You will get a repo in `<path/to/directory>/<project_name>`, which will contain your new library installed in 
-"editable mode" (i.e. with `pip install -e` ). The virtual environment is created by poetry. Documentation is built with
-jupyter-book and is published on github pages.
+"editable mode" (i.e. with `pip install -e`, we reccomend installing in poetry with `poetry install --with dev` ). 
+The virtual environment is created by poetry. Documentation is built with jupyter-book and is published on github pages.
 
 
 # Contributing

{{cookiecutter.project_name}}/docs/spelling_wordlist.txt

@@ -1,4 +1,3 @@
-tianshou
 arXiv
 tanh
 lr
@@ -255,5 +254,4 @@ javascript
 plotly
 appliedAI
 init
-pycharm
-tox
+pycharm