patrick/soundchanger
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typos

Browse Source
This commit is contained in:
Patrick Elmer 2023-03-12 16:14:29 +09:00
parent 7b4028fc41
commit 4f3be74602
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -25,16 +25,16 @@ options:
## Install
Navigate to the directory containing the code for this project and execute the following command:
Run the following command to install:
```
pip install .
pip install git+https://git.beelm.eu/patrick/soundchanger
```
After this, it should be callable from the command line using the `sc` command, or it can be imported in python projects in the following way:
After this, it will be callable from the command line using the `sc` command.
```python
from soundchanger import apply
```bash
sc --help
```
## Quick start
@ -78,14 +78,17 @@ If the input value is of type str, the output will also be of type str.
**Options**
- categories (default: {})
Which categories will be detected.
For vowels it would be {'V'='aeiou'} or {'V'=['a', 'e', 'i', 'o', 'u']})
- ignore_errors (default: True)
If this option is set to `True`, any erroneous sound change will be skipped.
If set to `False`, a ValueError will be raised instead.
- zero_characters (default: '∅-')
These characters will be removed in the changed words.
For example, `apply('h>∅', 'aha')` will return 'aa', not 'a∅a'.
@ -99,7 +102,7 @@ A > B / C _ D
which can be read as "A changes to B in the environment after C and before D.
A valid sound change must have at least az value for `A` and one `>` character. Thus, the sound change `a>` applied to the word `cat` would result in `ct`. The evironment (/C_D) is optional and can be used to specify environment-specific sound changes. Note that the hashtag symbol (`#`) is used for marking word boundaries (beginning and end of word). Thus, the sound change `p>f/#_` applies only at the beginning of a word. The word `papa` would change to `fapa`.
A valid sound change must have at least a value for `A` and one `>` character. Thus, the sound change `a>` applied to the word `cat` would result in `ct`. The evironment (/C_D) is optional and can be used to specify environment-specific sound changes. Note that the hashtag symbol (`#`) is used for marking word boundaries (beginning and end of word). Thus, the sound change `p>f/#_` applies only at the beginning of a word. The word `pana` would change to `fana`.
The input also recognizes categories, which must be specified manually. Common categories invole for example consonants (`C`) and vowels (`V`). A sound change that happens between two vowel must therefore be written in the following way: