Skip to content

Commit 21de2c8

Browse files
authored
Merge pull request #8543 from sylvestre/l10n-doc
Improvements of the docs
2 parents a81cf2b + 568de28 commit 21de2c8

3 files changed

Lines changed: 16 additions & 1 deletion

File tree

.vscode/cspell.dictionaries/workspace.wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,4 +347,5 @@ uutils
347347
getcwd
348348

349349
# * other
350+
weblate
350351
algs

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
[![CodeCov](https://codecov.io/gh/uutils/coreutils/branch/master/graph/badge.svg)](https://codecov.io/gh/uutils/coreutils)
1717
![MSRV](https://img.shields.io/badge/MSRV-1.85.0-brightgreen)
18+
[![Weblate](https://hosted.weblate.org/widget/rust-coreutils/svg-badge.svg)](https://hosted.weblate.org/projects/rust-coreutils/)
1819

1920
</div>
2021

@@ -41,9 +42,16 @@ cargo install coreutils
4142

4243
## Goals
4344

44-
uutils aims to be a drop-in replacement for the GNU utils. Differences with GNU
45+
uutils coreutils aims to be a drop-in replacement for the GNU utils. Differences with GNU
4546
are treated as bugs.
4647

48+
Our key objectives include:
49+
- Matching GNU's output (stdout and error code) exactly
50+
- Better error messages
51+
- Providing comprehensive internationalization support (UTF-8)
52+
- Improved performances
53+
- [Extensions](docs/src/extensions.md) when relevant (example: --progress)
54+
4755
uutils aims to work on as many platforms as possible, to be able to use the same
4856
utils on Linux, macOS, Windows and other platforms. This ensures, for example,
4957
that scripts can be easily transferred between platforms.
@@ -59,6 +67,7 @@ uutils has both user and developer documentation available:
5967
Both can also be generated locally, the instructions for that can be found in
6068
the [coreutils docs](https://github.com/uutils/uutils.github.io) repository.
6169

70+
Use [weblate/rust-coreutils](https://hosted.weblate.org/projects/rust-coreutils/) to translate the Rust coreutils into your language.
6271

6372
<!-- ANCHOR: build (this mark is needed for mdbook) -->
6473

docs/src/l10n.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This guide explains how localization (L10n) is implemented in the **Rust-based c
1010

1111
- **Main repository**: Contains English (`en-US.ftl`) locale files embedded in binaries
1212
- **Translation repository**: [uutils/coreutils-l10n](https://github.com/uutils/coreutils-l10n) contains all other language translations
13+
- **Online Translation**: [weblate/rust-coreutils](https://hosted.weblate.org/projects/rust-coreutils/) to translate the strings.
14+
1315

1416
---
1517

@@ -30,6 +32,9 @@ Examples:
3032

3133
These files follow Fluent syntax and contain localized message patterns.
3234

35+
The French translation is the only locale with English to be part of the tree. The goal is to be able to run tests with
36+
a different locale to verify that they work.
37+
3338
---
3439

3540
## ⚙️ Initialization

0 commit comments

Comments
 (0)