Update README.md

README.md

@@ -1 +1,61 @@
-# NeuroBox
+# NeuroBox
+
+NeuroBox is an open-source program for behavioural biotests with small aquatic model organisms. The interface includes software and hardware component that enables automated delivery of three independent and fully programmable stimuli behavioral bioassays. 
+
+![gui](https://github.com/Ayanaminn/NeuroBox/assets/49441654/83093416-5acb-48ac-8110-da0fc1666e10)
+
+
+**Please cite our manuscript:**
+
+Coming Soon
+
+
+Installation:
+------------
+### Requirements
+
+* Windows operating system.
+
+
+### Software
+
+1. Download the latest release from [Releases](https://github.com/Ayanaminn/NeuroBox/releases).
+
+2. Unzip file and double click to run "NeuroBox.exe".
+
+
+### Hardware
+
+1. Download the latest release from [Releases](https://github.com/Ayanaminn/NeuroBox/releases).
+
+2. Unzip file and open "NeuroBox_arduino" folder.
+
+3. Using [Arduino IDE](https://www.arduino.cc/en/software) to open the "NeuroBox_arduino.ino" and upload it to board.
+
+4. Wire output circuit to Arduino pin 5, 6 7 (default pin), if user prefer to use other pins, change pin number in the script accordingly and re-upload.
+
+
+Getting Started:
+------------
+
+1. Connect the Arduino with the computer.
+
+2. Run the programm, select the Arduino port, then click "Connect".
+
+3. Set custom protocols.
+
+4. Disconnect the Arduino before exit the program.
+
+
+License:
+------------
+
+GPL-3.0 License. See [LICENSE](https://github.com/Ayanaminn/PIZ/blob/master/LICENSE) for details.
+
+
+Contact:
+------------
+
+Should you have any questions about this application, please report an issue [here](https://github.com/Ayanaminn/NeuroBox/issues), or send an [email](mailto:yutao.bai@hotmail.com).
+
+If you have further interests about the research this program has been applied for, please [visit our website](https://neurotoxlab.com).