From d841d017580e43cc243ddd5af9ba9a245e173547 Mon Sep 17 00:00:00 2001 From: Rodrigo Queiro Date: Thu, 4 Jan 2018 12:06:47 +0100 Subject: [PATCH] Improve the two README.md files The root README.md is documentation for the GitHub repo, shown on the https://github.com/google/aiyprojects-raspbian. src/README.md is documentation for the API, which can't contain relative links to files in the GitHub repo. Fixes #214. --- README.md | 17 +++++++++++------ src/README.md | 23 ++++------------------- 2 files changed, 15 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 71ac65b1..13017755 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ -This repository contains an easy-to-use API for the AIY Voice Kit. -You can use it to create voice commands with simple while loops - have a look at the [demos](https://github.com/google/aiyprojects-raspbian/tree/voicekit/src). +This repository contains an easy-to-use API for the AIY Vision Kit and +AIY Voice Kit. +You can use it for face detection and object recognition, or use it to create +voice commands with simple while loops - have a look at the +[demos](https://github.com/google/aiyprojects-raspbian/tree/aiyprojects/src/examples). Documentation is at the [AIY Projects site](https://aiyprojects.withgoogle.com). For guidelines on contributing, look at [CONTRIBUTING.md](CONTRIBUTING.md). @@ -9,15 +12,17 @@ If you're using Raspbian instead of Google's provided image, read [HACKING.md](HACKING.md) for information on getting started. For returning users: -The old voice-recognizer demo remains in the [master branch](https://github.com/google/aiyprojects-raspbian/tree/master) of this project. -The new code is in the `voicekit` branch, and is included in images starting with aiyprojects-2017-09-11.img. +The code for all AIY kits is in the `aiyprojects` branch, and is included in +images starting with aiyprojects-2017-12-18.img. The previous `voicekit` branch +contains code just for the Voice Kit, and the `master` branch contains the +original, deprecated Voice Recognizer demo. # Support -If you're having trouble assembling your Voice Kit or running the demos, +If you're having trouble assembling your kit or running the demos, try the [AIY Forums](https://www.raspberrypi.org/forums/viewforum.php?f=114). -If you've found a bug in the AIY Voice Kit API or demos, you can look at the +If you've found a bug in the AIY API or demos, you can look at the [known issues](https://github.com/google/aiyprojects-raspbian/issues) or create a new one, or even fix it yourself and send us a pull request. diff --git a/src/README.md b/src/README.md index 027e8800..104dad7e 100644 --- a/src/README.md +++ b/src/README.md @@ -1,4 +1,4 @@ -This repository contains an easy-to-use API for the AIY Vision Kit and +aiyprojects is an easy-to-use API for the AIY Vision Kit and AIY Voice Kit. You can use it for face detection and object recognition, or use it to create voice commands with simple while loops - have a look at the @@ -6,21 +6,6 @@ voice commands with simple while loops - have a look at the Documentation is at the [AIY Projects site](https://aiyprojects.withgoogle.com). -For guidelines on contributing, look at [CONTRIBUTING.md](CONTRIBUTING.md). -If you're using Raspbian instead of Google's provided image, read -[HACKING.md](HACKING.md) for information on getting started. - -# Support - -If you're having trouble assembling your kit or running the demos, -try the [AIY Forums](https://www.raspberrypi.org/forums/viewforum.php?f=114). - -If you've found a bug in the AIY API or demos, you can look at the -[known issues](https://github.com/google/aiyprojects-raspbian/issues) or create -a new one, or even fix it yourself and send us a pull request. - -If you've found a problem with the Assistant (for example, crashes in the -library or incorrect responses), you can try -[the G+ community](https://plus.google.com/communities/117537996116836200696), -[Stack Overflow](https://stackoverflow.com/questions/tagged/google-assistant-sdk), -or [the assistant-sdk-python repo](https://github.com/googlesamples/assistant-sdk-python/). +If you have a problem or are looking for developer docs, look at the +GitHub repository's +[README.md](https://github.com/google/aiyprojects-raspbian#support).