From 0d4d4406fadf82b382367e59e99df1eb7630aa69 Mon Sep 17 00:00:00 2001 From: TheShadow Date: Sun, 8 Jan 2012 21:06:19 -0500 Subject: Added CHANGELOG, CREDITS, and README files --- CHANGELOG.markdown | 9 +++++++++ CREDITS.markdown | 20 ++++++++++++++++++++ README.markdown | 27 +++++++++++++++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 CHANGELOG.markdown create mode 100644 CREDITS.markdown create mode 100644 README.markdown diff --git a/CHANGELOG.markdown b/CHANGELOG.markdown new file mode 100644 index 0000000..ade604d --- /dev/null +++ b/CHANGELOG.markdown @@ -0,0 +1,9 @@ +#Java-Speech-API Changelog + +##Changelog +Changelog corresponds with a tagged and signed Git commit. This marks the changes. +A tagged commit may or may not have a corresponding binary version available. +Format: Tag: + +* Version 1.00 (Tag: v1.00) + * Initial Release \ No newline at end of file diff --git a/CREDITS.markdown b/CREDITS.markdown new file mode 100644 index 0000000..e712672 --- /dev/null +++ b/CREDITS.markdown @@ -0,0 +1,20 @@ +#Java-Speech API Credits + +##Credits +The following people/organizations have helped provide functionality for the API, + +* JavaFlacEncoder Project + * Provided functionality to convert Wave files to FLAC format + * This allowed for the FLAC audio to be sent to Google to be "recognized" + * Created by Preston Lacey + * Homepage: http://sourceforge.net/projects/javaflacencoder/ +* Google + * Provided functionality for two main API functions + * Recognizer + * Allows for speech audio to be recognized to text + * Synthesiser + * Allows for text to speech translation + * Homepage: http://google.com + +I would like to thank the above so much for your work, this wrapper/API could not have been +created without it. \ No newline at end of file diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..546a85a --- /dev/null +++ b/README.markdown @@ -0,0 +1,27 @@ +#Java-Speech-API + +This is the project for the Java Speech API written in Java. + +## Description +This API is designed to be simple and efficient, using the speech engines created by Google +to provide functionality for parts of the API. Essentially, it is an API written in Java, +including a recognizer, synthesizer, and a microphone capture utility. The project uses +Google services for the synthesizer and recognizer. While this requires an Internet +connection, it provides a complete, modern, and fully functional speech API in Java. + +##Features +The API currently provides the following functionality, + + * Microphone Capture API (Wrapped around the current Java API for simplicity) + * A speech recognizer using Google's recognizer service + * Converts WAVE files from microphone input to FLAC (using existing API, see CREDITS) + * Retrieves Response from Google, including confidence score and text + * A speech synthesiser using Google's synthesizer service + * Retrieves synthesized text in an InputStream (MP3 data ready to be played) + * Wave to FLAC API (Wrapped around the used API in the project, javaFlacEncoder, see CREDITS) + +##Changelog +See CHANGELOG.markdown for Version History/Changelog + +##Credits +See CREDITS.markdown for Credits -- cgit v1.2.3