Skip to content

Commit 02b0b21

Browse files
committed
Updated Readme
1 parent 81261c2 commit 02b0b21

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,29 @@ To use the script, run it from the command line with various options:
105105
- `python keystroke.py`: On running, a pop-up opens for connecting, and on pressing Start, blinks are detected to simulate spacebar key presses.
106106

107107
## Running All Applications
108+
Here's the updated section for the README:
109+
110+
---
111+
112+
### Running All Applications Together
113+
108114
To run all applications together:
109115
110-
```bash
111-
python app.py
112-
```
116+
```bash
117+
python app.py
118+
```
119+
120+
> [!NOTE]
121+
> Before running, make sure to activate the virtual environment and install all dependencies:
122+
123+
1. Activate the virtual environment:
124+
```bash
125+
.\venv\Scripts\activate
126+
```
127+
2. Install dependencies:
128+
```bash
129+
pip install -r chords_requirements.txt
130+
```
113131
114132
This will launch a Web interface. Use the interface to control the applications:
115133
@@ -122,11 +140,10 @@ This will launch a Web interface. Use the interface to control the applications:
122140
- `eog`: Process and detect blinks in EOG signals.
123141
- `emgenvelope`: Analyze EMG signals for muscle activity or gesture recognition.
124142
- `keystroke`: Monitor and analyze keystroke dynamics.
125-
- `game`: Launch an EEG game fro 2 players(Tug of War).
143+
- `game`: Launch an EEG game for 2 players(Tug of War).
126144
- `csv_plotter`: Plot data from a CSV file.
127145
- `gui`: Launch the GUI for real time signal visualization.
128146
129-
130147
## Troubleshooting
131148
132149
- **Arduino Not Detected:** Ensure the Arduino is properly connected and powered. Check the serial port and baud rate settings.

0 commit comments

Comments
 (0)