Add more info for contributing and changelog.

CHANGELOG.md

@@ -0,0 +1,21 @@
+# CHANGELOG.md
+
+## Unreleased
+
+#### Added
+
+- Scripts for collecting MNIST.
+- Option to collect grayscale data.
+
+#### Changed
+
+- Restructure example scripts, i.e. subfolder `recon` for reconstructions.
+- Remove heavy installs from setup (e.g. pycsou, lpips, skikit-image).
+
+#### Bugfix
+
+- 
+
+## 1.0.0 - (2022-03-21)
+
+First version!

CONTRIBUTING.md

@@ -50,3 +50,16 @@ to run all tests.
 7. Format the code (see above).
 8. Push your new branch to your fork.
 9. Open a pull request with the original repository.
+
+## Deploy new version to PyPi
+
+
+```
+# Create tag and upload
+git tag -a vX.X.X -m "Description."
+git push origin vX.X.X
+
+# Create package and upload to Pypi
+python setup.py sdist
+python -m twine upload  dist/lensless-1.0.1.tar.gz
+```

README.md

@@ -143,7 +143,7 @@ For example, for ADMM:
     res = recon.apply(n_iter=n_iter)
 ```
 
-A full running example can run like so:
+A full running example can be run like so:
 ```bash
 python scripts/recon/admm.py --psf_fp data/psf/tape_rgb.png \
 --data_fp data/raw_data/thumbs_up_rgb.png --n_iter 5

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="lensless",
-    version="0.0.1",
+    version="1.0.0",
     author="Eric Bezzam",
     author_email="[email protected]",
     description="Package to control and image with a lensless camera running on a Raspberry Pi.",