MycroftAI / mycroft-dinkum

A consumer ready version of Mycroft specifically for the Mark II.
Apache License 2.0
20 stars 8 forks source link

Missing documentation for setting up a development environment #48

Open Ramblurr opened 1 year ago

Ramblurr commented 1 year ago

Describe the bug

The README and docs do not describe how to setup a local development environment for dinkum (without using mark ii hardware).

Expected behavior

The documentation for mycroft-core is very extensive! I'm not necessarily asking for something that comprehensive, though it would be nice.

A an addition to the README like this would suffice:

git clone ...
python3 -m virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt
./bin/go

Looking at the scripts it seems its heavily tied to systemd.. which isn't ideal on a dev workstation, but not a deal breaker. I'd be happy to run a virtual machine too.. it's just getting the toolchain and deps installed that I don't know where to start.

Merry Christmas by the way! Loving my Mark II, really looking forward to hacking on it over the coming weeks.

jmillerv commented 1 year ago

Seconding this. My current plan is to just have two flash drives that I swap into the hardware, but that is something of a pain to do