branch develop updated (9289f15 -> 0fd6c95)
This is an automated email from the git hooks/post-receive script. New change to branch develop in repository say-my-texts. See https://gitlab.nuiton.org/chorem/say-my-texts.git from 9289f15 :whale: Update docker image new 0fd6c95 :memo: add pages The 1 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "adds" were already present in the repository and have only been added to this reference. Detailed log of new commits: commit 0fd6c95420b0b79d4cbf1244a9a93ddf8a49dd49 Author: Kevin Morin <morin@codelutin.com> Date: Wed Nov 8 18:27:12 2017 +0100 :memo: add pages Summary of changes: .gitlab-ci.yml | 2 + .../images/logos => docs/img}/smt_logo_title.png | Bin src/site/rst/user.rst => docs/index.md | 71 +++++++-------------- mkdocs.yml | 22 +++++++ 4 files changed, 46 insertions(+), 49 deletions(-) copy {src/site/fr/resources/images/logos => docs/img}/smt_logo_title.png (100%) copy src/site/rst/user.rst => docs/index.md (54%) create mode 100644 mkdocs.yml -- To stop receiving notification emails like this one, please contact chorem.org SCM administrator <admin+scm@chorem.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository say-my-texts. See https://gitlab.nuiton.org/chorem/say-my-texts.git commit 0fd6c95420b0b79d4cbf1244a9a93ddf8a49dd49 Author: Kevin Morin <morin@codelutin.com> Date: Wed Nov 8 18:27:12 2017 +0100 :memo: add pages --- .gitlab-ci.yml | 2 ++ docs/img/smt_logo_title.png | Bin 0 -> 15411 bytes docs/index.md | 69 ++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 22 ++++++++++++++ 4 files changed, 93 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8dc1eba..c2b0a18 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -11,6 +11,8 @@ build: artifacts: paths: - target/saymytexts-*.apk + tags: + - android pages: image: python:alpine diff --git a/docs/img/smt_logo_title.png b/docs/img/smt_logo_title.png new file mode 100644 index 0000000..22167ce Binary files /dev/null and b/docs/img/smt_logo_title.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e67f16d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,69 @@ +#Welcome to Say My Texts website + +Say My Texts is an Android application which reads out loud the SMS you receive. +This is particularly useful when you are riding, running or driving. +You also can reply to the sender by calling him or by dictating the reply. + + +## Installation + +To install the application, you need a device with at least Android Ice Cream Sandwich 4.0.3. + +The application needs a voice synthetizer. If none is installed, you will be able to install one from the application. + +Once the application is installed, you need to launch it once to activate it. +It will be automatically activated the next times you start the device. + + +### Permissions + +The application needs the following permissions: + +- *RECEIVE_SMS* to receive the SMS +- *SEND_SMS* the user can send SMS to himself to test +- *READ_PHONE_STATE* to check that the user is not in a call +- *MODIFY_AUDIO_SETTINGS* the voice synthetizer needs it +- *READ_CONTACTS* to match the phone number of the sender with the contact name +- *BLUETOOTH* to get the connected devices +- *RECORD_AUDIO* pour les commandes vocales et dicter la rĂ©ponse +- *CALL_PHONE* pour rappeler l'expĂ©diteur + + +### Settings + +When you launch the application from the menu, the settings open. +You can: + +- enable or disable the reading depending if a headset is plugged or not or if a bluetooth device is connected +- enable or disable the interaction with the received messages (only if a voice recognizer is installed) +- if the interaction is enabled, you can configure the maximum number of tries to understand the vocal commands (3 by default) +- enable or disable the [Heisendroid mode](#Heisendroid_mode). +- send a SMS to yourself to test the reading + +#### Heisendroid mode + +The name *Say My Texts* is a reference to the American TV show *Breaking Bad*. +The logo character's name is *Heisendroid*, +in reference to Walter White's pseudonym in the series (Heisenberg). + +When you enable the Heisendroid mode, the SMS reading is preceded by "*Say my text*" +and followed by "*You're goddamn right!*". It is also a reference to one of the cult line of the series. + + +### Interactions + +If the interaction is on, when you receive an SMS, the app offers you 3 choices: + +- call the sender (say "call") +- reply by SMS by dictating the message (say "repy") +- do nothing (say "nothing") + +If you choose to reply by SMS, you can then dictate the message. The application will tell what it understands. +You can then: + +- confirm and send the reply (say "confirm") +- dictate the text again (say "modify") +- cancel the reply and quit (say "cancel") + +If the app does not understand what you said (it happens), you will be asked to repeat. + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..9f6e76e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: Say My Texts +site_url: https://saymytexts.nuiton.org +copyright: 'Copyright © 2017 Code Lutin' + +repo_name: Gitlab +repo_url: https://gitlab.nuiton.org/chorem/saymytexts + +pages: + - 'index.md' +theme: material +extra: + social: + - type: 'gitlab' + link: 'https://gitlab.nuiton.org/chorem/saymytexts' + palette: + primary: 'green grey' + accent: 'teal' + logo: 'img/smt_logo_title.png' +markdown_extensions: + - admonition + - codehilite + - toc(permalink=true) -- To stop receiving notification emails like this one, please contact chorem.org SCM administrator <admin+scm@chorem.org>.
participants (1)
-
chorem.org scm