Rename and organise the repo

jurc192 · jurc192 · commit bea524f7bcbd · 2022-06-02T11:43:13.000+02:00
diff --git a/Pipfile b/Pipfile
@@ -14,4 +14,4 @@ pyqtgraph = "*"
 [dev-packages]
 
 [requires]
-python_version = "3.10"
+python_version = "3.8"
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# PSplot
+
+*A lightweight tool for obtaining and visualising the discrete near-infrared (NIR) data using the Plastic Scanner.*
+
+![PSplot screenshot](screenshot.png)
+
+
+
+> WARNING: still in early development, not a stable release! See GitHub [issues](https://github.com/Plastic-Scanner/PSplot/issues)
+
+
+
+## Installation
+
+Requires python >=3.8, pipenv
+Install python dependencies (listed in Pipfile):
+```
+$ pipenv install
+```
+
+Start the shell and run the program:
+```
+$ pipenv shell
+$ python psplot.py
+```
+Use `exit` or Ctrl+D to exit pipenv shell
+
+
+## Usage
+
+Select the serial device from the dropdown menu on the top (e.g. /dev/ttyACM0 or COM5). Dummy data will be used when no device connected.  
+Use spacebar to get a measurement (plot needs to be focused/clicked first, see [bug](https://github.com/Plastic-Scanner/PSplot/issues/12)).
+Using the "calibrate" button it performs a measurement, taken as a reference - displaying measurements between 0 and 1.
+
+
+## Contributing
+
+Feel free to improve, modify and contribute to this project. It's part of the [Plastic Scanner](plasticscanner.com) open source hardware development, check out the [docs](docs.plasticscanner.com) as well!
+
diff --git a/psplot.py b/psplot.py
@@ -63,7 +63,7 @@ def keyPressEvent(self, event):
                     
                 QApplication.clipboard().setText(copy_text)
 
-class Spectraplot(QMainWindow):
+class PsPlot(QMainWindow):
     def __init__(self):
         super().__init__()
 
@@ -283,6 +283,6 @@ def plot(self, data):
 if __name__ == "__main__":
 
     app = QApplication(sys.argv)
-    window = Spectraplot()
+    window = PsPlot()
     window.show()
     app.exec()
diff --git a/screenshot.png b/screenshot.png
