README updates

Quasars · Nov 14, 2024 · 33b93ed · 33b93ed
1 parent ff0505e
commit 33b93ed
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -2,31 +2,28 @@ orange-spectroscopy-prototypes
 ==============================
 
 Prototype widgets / code for the [orange-spectroscopy](https://github.com/Quasars/orange-spectroscopy)
-add-on for [Orange3](http://orange.biolab.si).
+add-on for [Orange3](http://orange.biolab.si) / [Quasar](https://quasar.codes/).
+
+⚠️ No guarantees of forward/backward compatibility: workflows based on this add-on may break in the future!
 
 Installation
 ------------
 
 To use this add-on, first download and install the current version of
-[Orange3](http://orange.biolab.si). Next, install the orange-spectroscopy add-on:
-
-1. Open Orange Canvas, choose "Options" from the menu and then "Add-ons".
-2. A new window will open. There, tick the checkbox in front of "Spectroscopy" and confirm.
-3. Restart Orange.
-
-Finally, install the prototypes add-on:
+[Quasar](https://quasar.codes/). Then
 
-1. Download and unzip the release zip file.
-2. Enter the folder in your python environment. For a standard Orange
-   install you should use "Orange Command Prompt"
-3. Run `pip install .` from the folder.
+1. Open Quasar/Orange, choose "Options" from the menu and then "Add-ons".
+2. A new window will open. There, press the "Add more..." button.
+3. Enter "orange-spectroscopy-prototypes" in the dialog
+4. Tick the checkbox in front of "Spectroscopy Prototypes" and confirm.
+3. Restart Quasar/Orange.
 
 Usage
 -----
 
 After the installation, the widgets from this add-on are registered with
 Orange. The new widgets will appear in Orange Canvas, in the toolbox bar
-under the section Spectroscopy-Prototypes.
+under the section "Spectroscopy Prototypes".
 
 Example workflows can be found under the "Help / Examples" menu.
 
@@ -35,11 +32,16 @@ For developers
 
 If you would like to install from cloned git repository, run
 
-    pip install .
+    pip install .[doc,test,dev]
 
 To register this add-on with Orange, but keep the code in the development
 directory (do not copy it to Python's site-packages directory), run
 
-    pip install -e .
+    pip install -e .[doc,test,dev]
+
+The repository has [pre-commit](https://pre-commit.com/) hooks configured, you
+can set them up with
+
+    pre-commit install
 
 Further details can be found in orange-spectroscopy [CONTRIBUTING.md](https://github.com/Quasars/orange-spectroscopy/blob/master/CONTRIBUTING.md)
diff --git a/README.pypi b/README.pypi
@@ -2,3 +2,5 @@ orange-spectroscopy-prototypes
 ==============================
 
 Prototypes for orange-spectroscopy Orange add-on for spectral data analysis.
+
+️ No guarantees of forward/backward compatibility: workflows based on this add-on may break in the future!
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,3 +2,5 @@ orange-spectroscopy-prototypes
		==============================

		Prototypes for orange-spectroscopy Orange add-on for spectral data analysis.

		️ No guarantees of forward/backward compatibility: workflows based on this add-on may break in the future!