Skip to content
This repository has been archived by the owner on Feb 9, 2023. It is now read-only.

Update info on HACKING.md #36

Merged
merged 1 commit into from
May 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,22 @@

We recommend using [the images](https://aiyprojects.withgoogle.com/voice) we
provide. Those images are based on [Raspbian](https://www.raspberrypi.org/downloads/raspbian/),
with a few customizations and are tested on the Raspberry Pi 3.
with a few customizations and are tested on the Raspberry Pi 3. If you prefer
to setup Raspbian yourself, there are some manual steps you need to take.

## Installing the dependencies

First, make sure you have `git` installed and clone this repository in
`~/voice-recognizer-raspi`:

```shell
sudo apt-get install git
cd
git clone https://github.com/google/aiyprojects-raspbian.git voice-recognizer-raspi
```

Then, install the project dependencies and setup the services:

If you prefer to setup Raspbian yourself, install the project dependencies and
setup services:
``` shell
cd ~/voice-recognizer-raspi
scripts/install-deps.sh
Expand All @@ -16,6 +28,7 @@ sudo scripts/install-services.sh

To use the Voice HAT, you'll need to upgrade your kernel to 4.9, then adjust the
kernel and ALSA configuration:

``` shell
sudo apt-get update
sudo apt-get install raspberrypi-kernel
Expand All @@ -39,7 +52,9 @@ Raspberry Pi by running:
``` shell
make deploy
```

To execute the script on the Raspberry Pi run, login to it and run:

``` shell
cd ~/voice-recognizer-raspi
source env/bin/activate
Expand All @@ -48,7 +63,7 @@ python3 src/main.py

# I18N

Strings wrapped with `_()` are marked for translation.
Strings wrapped with `_()` are marked for translation:

``` shell
# update catalog after string changed
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
This repository contains the source code for the AIYProjects "Voice Kit". See
https://aiyprojects.withgoogle.com/voice/
https://aiyprojects.withgoogle.com/voice/.

If you're using Rasbian instead of Google's provided image, read
[HACKING.md](HACKING.md) for information on getting started.

## Troubleshooting

Expand Down