~alcinnz/rhapsode

ref: 4e9630a1e7a9286c64250bff34361792537cf841 rhapsode/README.md -rw-r--r-- 2.4 KiB
4e9630a1 — Adrian Cochrane Update el-time.md 4 years ago
                                                                                
e7966356 Adrian Cochrane
6aa42076 Adrian Cochrane
e7966356 Adrian Cochrane
d310e8f0 Adrian Cochrane
e0502097 Adrian Cochrane
d310e8f0 Adrian Cochrane
e0502097 Adrian Cochrane
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Rhapsode

Web browser targetting voice I/O.

## Desired Experience
Rhapsode will read a webpage outloud to you according to some special CSS properties. Arrow key navigation will be supported for navigation between headings, paragraphs, and table cells.

Links (defined generally enough to include `<audio>`, etc) will be indicated via a special beep for the user to repeat one back (via microphone or keyboard) at any time in order to navigate between pages. Rhapsode will start reading from the `<main>` element if present.

Forms will be rendered as ordinary elements and be navigated to as a link. Once navigated to you will be prompted to fill each input of the form in turn before reviewing/correcting your submission before sending it.

## Why?
Because I want The Web to be "universal", for browsers to have the slack they need to present it however best suits their users and the devices they use. Rhapsode demonstrates HTML/CSS's capabilities this way.

See the wiki for webdev documentation.

## Installation/Running
1. Install `espeak-ng`, `zlib1g-dev`, `ghc`, and `cabal-install`. (Debian package names listed here)
2. From within the git repository, run `cabal install`. This'll compile Rhapsode and all it's other dependencies.
3. (OPTIONAL) Add `~/.cabal/bin/` to your path if it isn't already.
4. Run Rhapsode with `cabal run https://example.com/ | espeak-ng -mb1`, where "https://example.com/" can/should be replaced any valid URL. Or if you followed step 3, you can replace "cabal run" with "rhapsode".

Currently Rhapsode is outputting SSML markup, which is why the output is piped into eSpeak NG. The `-m` flag tells espeak to interpret the SSML. The `b1` flag tells it that the output is in UTF-8, without it eSpeak may stumble through the reading. See `espeak-ng --help` for more options.

It is a known issue that audio cues aren't being played and eSpeak may read out some of the SSML markup rather than follow it's instructions. These'll be easily fixed once eSpeak NG is embedded into the Rhapsode executable.

## Contributing
You can contributed code or register "issues" to Haskell Stylist by contacting me (Adrian Cochrane) via mastodon or email. Or you can sign up for an account on the NZ OSS GitLab.
If you're contributing code you can link me to where you're hosting your git fork, or send a patch file. Or if you simply to ask for more features or fixes don't hesitate to contact me!