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

Commit

Permalink
Improve the two README.md files
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
drigz authored and PeterMalkin committed Jan 4, 2018
1 parent 2c808d8 commit 8fb6156
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 25 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
<img src="https://aiyprojects.withgoogle.com/static/images/icons/aiy-circular-logo.svg" width="40%">

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).
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.

Expand Down
23 changes: 4 additions & 19 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,11 @@
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
[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).
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).

0 comments on commit 8fb6156

Please sign in to comment.