Skip to content

Commit a2fd41e

Browse files
authored
docs: fix grammar mistake in README
docs: properly link the stas-server references to its repository
1 parent 74c80eb commit a2fd41e

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ An alternative standalone Light Novel translator for Sugoi Translator.
1010

1111
stas-ln-translator name is an abbreviation of Sugoi Translator Alternative Standalone Light Novel Translator.
1212

13-
Some parts of this program based on Light-Novel-EPUB-Translator that included in Sugoi Translator.
13+
Some parts of this program are based on Light-Novel-EPUB-Translator, which is included in Sugoi Translator.
1414

1515
Not affiliated with Sugoi Translator.
1616

1717
## Features
1818

19-
- Fast because API requests to Server are handled concurrently.
20-
- Batch mode by default to cut down number of requests needed significantly.
21-
- stas-server as a first-class citizen with compatibility with Sugoi Translator.
19+
- Fast because API requests to the Server are handled concurrently.
20+
- Batch mode is used by default to cut down the number of requests needed significantly.
21+
- [stas-server](https://github.com/mddanish00/stas-server) as a first-class citizen with compatibility with Sugoi Translator.
2222
- Standalone, not tightly coupled like Light-Novel-EPUB-Translator.
2323

2424
## User Guide
2525

2626
### Requirements
2727

28-
- stas-server or Sugoi Offline Translator (only `request_type=Single` can be used).
28+
- [stas-server](https://github.com/mddanish00/stas-server) or Sugoi Offline Translator (only `request_type=Single` can be used).
2929

30-
- Python 3.12 or Python 3.13. Python 3.14 and above are still not supported.
30+
- Python 3.12 or Python 3.13. Python 3.14 and later are not yet supported.
3131

3232
### Installation
3333

@@ -74,9 +74,9 @@ Options:
7474
|Name|Default|Description|
7575
|----|-------|-----------|
7676
|batch_size|100|Number of lines per batch in a request.|
77-
|request_type|Batch|Request type used when contacting API. Either `Single` or `Batch`.|
77+
|request_type|Batch|Request type used when contacting the API. Either `Single` or `Batch`.|
7878
|tag_to_translate|p,h1,h2,h3,h4,h5,h6,title|HTML elements to translate, separated by commas.|
79-
|translator_api_url|http://localhost:14366|stas-server or any other Sugoi Translator compatible API URL.|
79+
|translator_api_url|http://localhost:14366|[stas-server](https://github.com/mddanish00/stas-server) or any other Sugoi Translator compatible API URL.|
8080

8181
## Development
8282

@@ -86,8 +86,6 @@ To start developing for this project, make sure to install uv. It will automatic
8686

8787
Refer to [uv official docs](https://docs.astral.sh/uv/getting-started/installation/) for the installation instructions.
8888

89-
You need to make sure install ICU if in Linux yourself. For Windows, you need to use my python index to install PyICU.
90-
9189
Initialise the virtual environment and install dependencies.
9290

9391
```commandline
@@ -122,8 +120,8 @@ This project is licensed under the [MIT license](./LICENSE).
122120

123121
## Other License
124122

125-
Light-Novel-EPUB-Translator project is part of Sugoi Japanese Toolkit is licensed under the [MIT license](./LICENSE-Light-Novel-EPUB-Translator).
123+
Light-Novel-EPUB-Translator project is part of the Sugoi Japanese Toolkit and is licensed under the [MIT license](./LICENSE-Light-Novel-EPUB-Translator).
126124

127125
## Acknowledgement
128126

129-
- Thanks to [MingShiba](https://www.patreon.com/mingshiba) for creating the Sugoi Japanese Toolkit and making high-quality (still machine translation) available to enjoy many untranslated Japanese works.
127+
- Thanks to [MingShiba](https://www.patreon.com/mingshiba) for creating the Sugoi Japanese Toolkit and making high-quality (still machine translation) available to enjoy many untranslated Japanese works.

0 commit comments

Comments
 (0)