Merge branch 'master' of github.com:Bitcoin-Brainbow/Brainbow

buildozer.spec

@@ -388,8 +388,9 @@ android.debug_artifact = apk
 #p4a.fork = kivy
 
 # (str) python-for-android branch to use, defaults to master
-p4a.branch = master
+#p4a.branch = master
 #p4a.branch = develop
+p4a.branch = release-2022.12.20
 
 # (str) python-for-android specific commit to use, defaults to HEAD, must be within p4a.branch
 #p4a.commit = HEAD

install.md

@@ -0,0 +1,53 @@
+# How to run the sources on your own machine 
+
+## Create a Python3 virtual environment
+
+```shell
+python -m venv ~/brainbowenv/
+```
+
+## Activate the Python3 virtual environment 
+
+```shell
+source ~/brainbowenv/bin/activate
+```
+
+Note: you can deactivate the python environment at any time with the command `deactivate`
+read more about it [here](https://docs.python.org/3/library/venv.html)
+
+## Clone Brainbow repository and install requirements
+
+```shell
+git clone https://github.com/Bitcoin-Brainbow/Brainbow.git brainbow
+cd brainbow/
+```
+
+Add the following to the new_requirements.txt
+
+kivy-garden
+kivy
+kivy_garden.graph
+kivy_garden.qrcode
+embit
+numpy
+camera4kivy
+pyzbar
+
+```shell
+pip install -r new_requirements.txt
+```
+
+Note: for MacOS install zbar with brew
+
+```shell
+brew install zbar
+```
+
+## Start the app
+
+```shell
+python main.py
+```
+
+## NOTES:
+- Tor must be installed and running.