finish version

Author: ZeroIntensity

CONTRIBUTING.md

@@ -4,79 +4,24 @@ If you would like to contribute to pointers.py, just make a pull request with yo
 
 Any pull request should include the following:
 
-- Type safe and provides type annotations
-- PEP 8 compliant code
-- Passes tests specified in the [tests](https://github.com/ZeroIntensity/pointers.py/tree/master/tests) directory
-- Documentation updated accordingly
+-   Type safe and provides type annotations
+-   PEP 8 compliant code
+-   Passes tests specified in the [tests](https://github.com/ZeroIntensity/pointers.py/tree/master/tests) directory
+-   Documentation updated accordingly
 
 ## Running tests
 
-You can install the tests by installing dependencies in the `requirements_dev.txt` file:
+Pointers.py uses [pre-commit](https://pre-commit.com/) and [pytest](https://docs.pytest.org/en/7.1.x/) for running tests.
 
-```
-pip install -r requirements_dev.txt
-```
-
-### Mypy
-
-Mypy type checks the code.
-
-You can run it with the following command:
-
-```
-python3 -m mypy src
-```
-
-### Flake8
-
-Flake8 ensures that the codebase is compliant to [PEP 8](https://peps.python.org/pep-0008/).
-
-Heres how you run it:
-
-```
-python3 -m flake8 src
-```
-
-### Pytest
-
-Pytest handles all unit tests for pointers.py
-
-Run it by simply using:
+To get pre-commit running, simply run the following:
 
 ```
-python3 -m pytest
+$ pip install pre-commit
+$ pre-commit install
 ```
 
-### Tox
-
-Tox runs all 3 of the above in different python environments:
+Then, just install pytest:
 
 ```
-python3 -m tox
+$ pip install pytest
 ```
-
-Please note that running tox is extremely slow and can take several minutes.
-
-## Running documentation
-
-Start with installing [mkdocs](https://pypi.org/project/mkdocs/):
-
-```
-python3 -m pip install -U mkdocs
-```
-
-To build the documentation, run the following command:
-
-```
-python3 -m mkdocs build
-```
-
-This will build the site in the `site/` directory.
-
-However, constantly building can be annoying, so you can use `serve` instead:
-
-```
-python3 -m mkdocs serve
-```
-
-This will automatically rebuild when you change a file.

README.md

@@ -70,11 +70,3 @@ python3 -m pip install -U pointers.py
 ```
 py -3 -m pip install -U pointers.py
 ```
-
-### Running Documentation
-
-```
-$ git clone https://github.com/ZeroIntensity/pointers.py && cd pointers.py
-$ pip install -U mkdocs
-$ mkdocs serve
-```

docs/movement.md

@@ -40,7 +40,7 @@ b = to_ptr("abcdefg")
 a.move(b) # InvalidSizeError
 ```
 
-This can be bypassed by passing `unsafe = True` to `move`:
+This can be bypassed by passing `unsafe=True` to `move`:
 
 ```py
 a = to_ptr("test")
@@ -98,7 +98,7 @@ print(~ptr)
 
 ## Consequences
 
-After you are finished crying from accidentally overwriting your newborn child using this library, what actually happens when we break something with overwriting?
+What actually happens when we break something with overwriting?
 
 Lets use the following code as an example: