Merge pull request #23 from Helment/change_paths_and_board_versions

Change paths and board versions

Author: Helment

.gitignore

@@ -2,6 +2,6 @@ backend/__pycache__/*.pyc
 __pycache__/*.pyc
 frontend/__pycache__/*.pyc
 settings.cfg
-neurigui/backend/__pycache__/*.pyc
-neurigui/frontend/__pycache__/*.pyc
-neurigui/__pycache__/*.pyc
+neuri/backend/__pycache__/*.pyc
+neuri/frontend/__pycache__/*.pyc
+neuri/__pycache__/*.pyc

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 Helment (Brain Machine Wellness Solutions SpA)
+Copyright 2023 David Marcel BAUM
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

README.md

@@ -5,7 +5,11 @@ Neuri is an EEG board developed by Helment. This GUI is working with Neuri versi
 2. Forward the signal (raw) in to a serial port located at 127.0.0.1:XYZ. This allows you to connect any of your applications to the GUI and to work with the acquired signal in real-time.
 3. Store the data in an open text format for offline analysis (default: "Helment_[datetime].txt")
 
-![Main view of GUI](./neurigui/assets/Neuri_GUI_main_window.png)
+![Main view of GUI](./neuri/assets/Neuri_GUI_main_window.png)
+
+Watch the introdction on Youtube:
+
+[![Watch the introdcution](https://img.youtube.com/vi/8DbGR9KUszQ/hqdefault.jpg)](https://www.youtube.com/embed/8DbGR9KUszQ)
 
 ## Setup
 
@@ -29,8 +33,8 @@ Other Linux specific steps are:
 ### Compilation
 
 The compiled version the the Neuri GUI runs way faster and has more stable  execution speed of iteration loops inside the backend of the GUI. You can **compile the GUI with Nuitka**:
-- Windows: `nuitka ./neuri_gui.py --onefile --enable-plugin=tk-inter --standalone --enable-plugin=pyqt5 --include-data-dir=./frontend/=data --windows-icon-from-ico=frontend/Isotipo-Helment-color.ico --windows-disable-console`
-- GNU/Linux: `nuitka3 ./neuri_gui.py --onefile --enable-plugin=tk-inter --standalone --enable-plugin=pyqt5 --include-data-dir=./frontend/=data --windows-icon-from-ico=frontend/Isotipo-Helment-color.ico --windows-disable-console` (note the 3 in nuitka3 compared to Windows)
+- Windows: `nuitka ./gui.py --onefile --enable-plugin=tk-inter --standalone --enable-plugin=pyqt5 --include-data-dir=./frontend/=data --windows-icon-from-ico=frontend/Isotipo-Helment-color.ico --windows-disable-console`
+- GNU/Linux: `nuitka3 ./gui.py --onefile --enable-plugin=tk-inter --standalone --enable-plugin=pyqt5 --include-data-dir=./frontend/=data --windows-icon-from-ico=frontend/Isotipo-Helment-color.ico --windows-disable-console` (note the 3 in nuitka3 compared to Windows)
 
 ### Packaging
 
@@ -40,10 +44,10 @@ The GUI is packageable into a **Python module**. For this, run inside the root f
 
 ### Installing and running
 
-The GUI can be run directly from an IDE by calling the `Run()` function found in "./neurigui/neuri_gui.py".
+The GUI can be run directly from an IDE by calling the `Run()` function found in "./neuri/gui.py".
 You can also **install it as a Python module** pointing pip to the root folder of the project (NeuriGUI): `pip install ./path/to/NeuriGUI`. This will install the module found in "NeuriGUI/dist". You can then run the GUI from your own scripts such as:
 ```
-import neurigui.neuri_gui as ng
+import neuri.gui as ng
 ng.Run()
 ```