Skip to content

Commit e3a2b56

Browse files
committed
chore: minor edits on the readme
1 parent 413dfa1 commit e3a2b56

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,25 @@ SayIt is a cross-platform command line tool that pronounces written text.
77
You can use it to create audio recordings of your text files or
88
to improve your pronunciation in a foreign language.
99

10-
## Installation
10+
## Setup
1111

1212
SayIt uses [Azure Cognitive Services][az-cs] as backend to guarantee
1313
optimal audio quality, so it requires a subscription to Azure, which you can get for free
1414
[here][az-sub].
15-
Azure Cognitive Services [free tier][az-cs-price] includes 5 text-to-speech
15+
Azure Cognitive Services [free tier][az-cs-price], as of 2021, includes 5 text-to-speech
1616
hours per month, which is often enough for personal use.
1717

1818
You can download SayIt in the [release section][release].
1919
SayIt is currently distributed both as self-contained .NET executable
2020
(which means you won't need to install the .NET runtime to use it)
21-
and as framework-dependent .NET 5 executable.
21+
and as framework-dependent .NET executable.
22+
23+
At the first use you're required to run the setup wizard (`./sayit --setup`)
24+
and enter the configuration parameters of your Azure Cognitive Services resource,
25+
such as the subscription key (which you can find in the Azure portal)
26+
and the region identifier (see [here][region-ids]).
27+
SayIt will store these parameters in the configuration folder of the current
28+
user (e.g. `~/.config/` in Linux) as an [App Setting XML file][appsetting].
2229

2330
## Usage
2431

@@ -45,19 +52,13 @@ OPTIONS:
4552
--output, -o <output> the path of the output file
4653
--help display this list of options.
4754
```
48-
At the first use you're required to run the setup wizard (`./sayit --setup`)
49-
and enter the configuration parameters of your Azure Cognitive Services resource,
50-
such as the subscription key (which you can find in the Azure portal)
51-
and the region identifier (see [here][region-ids]).
52-
SayIt will store these parameters in the configuration folder of the current
53-
user (e.g. `~/.config/` in Linux) as an [App Setting XML file][appsetting].
5455

5556
SayIt supports these settings:
5657
- [languages][voices]: English, Italian, French, German, Spanish, Hindi, Portuguese, Russian, Japanese and Chinese (Mandarin).
5758
- [output formats][output-formats]: `audio-16khz-32kbitrate-mono-mp3`, `audio-16khz-64kbitrate-mono-mp3`, `audio-16khz-128kbitrate-mono-mp3`, `audio-24khz-96kbitrate-mono-mp3`, `audio-24khz-160kbitrate-mono-mp3`, `audio-24khz-48kbitrate-mono-mp3`, `riff-8khz-16bit-mono-pcm`, `riff-16khz-16bit-mono-pcm`, `riff-24khz-16bit-mono-pcm`.
5859

59-
> NB: some languages and output formats might not be supported by your Azure Cognitive Services resource,
60-
depending on its region (see [here][region-voices]).
60+
> NB: some languages and output formats might not be supported by your
61+
Azure Cognitive Services resource, depending on its region (see [here][region-voices]).
6162

6263
> NB: the choice of supported voices and formats has been somewhat random. I
6364
> welcome suggestions and contributions, of course.

0 commit comments

Comments
 (0)