diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..cd8a8618 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "buildroot"] + path = buildroot + url = https://github.com/buildroot/buildroot.git + branch = 2018.08.x diff --git a/README.md b/README.md index 4ddc4d71..8842a0f0 100644 --- a/README.md +++ b/README.md @@ -13,4 +13,12 @@ The software stack of Mycroft creates a hackable open source voice assistant. At this moment development is in very early stages and focussed on the Raspberry Pi 3B. As soon as an initial first workable version is created, other hardware might be added. -Building instructions will follow soon... +### Getting the code + +First, get the code on your system! The simplest method is via git. + +- `cd ~/` +- `git clone --recurse-submodules https://github.com/j1nx/MycroftOS.git` +- `cd MycroftOS` + +More building instructions will follow soon...