From e9122c59b1a284ab20f951668926b7e2093b1697 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Mon, 1 Sep 2025 23:22:40 +0200 Subject: [PATCH 1/2] doc/l10n: improve the doc --- .vscode/cspell.dictionaries/workspace.wordlist.txt | 1 + README.md | 2 ++ docs/src/l10n.md | 5 +++++ 3 files changed, 8 insertions(+) diff --git a/.vscode/cspell.dictionaries/workspace.wordlist.txt b/.vscode/cspell.dictionaries/workspace.wordlist.txt index eabcfb611..2c8bada09 100644 --- a/.vscode/cspell.dictionaries/workspace.wordlist.txt +++ b/.vscode/cspell.dictionaries/workspace.wordlist.txt @@ -347,4 +347,5 @@ uutils getcwd # * other +weblate algs diff --git a/README.md b/README.md index 1d9a7ddd1..ae6f4a682 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ [![CodeCov](https://codecov.io/gh/uutils/coreutils/branch/master/graph/badge.svg)](https://codecov.io/gh/uutils/coreutils) ![MSRV](https://img.shields.io/badge/MSRV-1.85.0-brightgreen) +[![Weblate](https://hosted.weblate.org/widget/rust-coreutils/svg-badge.svg)](https://hosted.weblate.org/projects/rust-coreutils/) @@ -59,6 +60,7 @@ uutils has both user and developer documentation available: Both can also be generated locally, the instructions for that can be found in the [coreutils docs](https://github.com/uutils/uutils.github.io) repository. +Use [weblate/rust-coreutils](https://hosted.weblate.org/projects/rust-coreutils/) to translate the Rust coreutils into your language. diff --git a/docs/src/l10n.md b/docs/src/l10n.md index 5704004ce..bb00aa204 100644 --- a/docs/src/l10n.md +++ b/docs/src/l10n.md @@ -10,6 +10,8 @@ This guide explains how localization (L10n) is implemented in the **Rust-based c - **Main repository**: Contains English (`en-US.ftl`) locale files embedded in binaries - **Translation repository**: [uutils/coreutils-l10n](https://github.com/uutils/coreutils-l10n) contains all other language translations +- **Online Translation**: [weblate/rust-coreutils](https://hosted.weblate.org/projects/rust-coreutils/) to translate the strings. + --- @@ -30,6 +32,9 @@ Examples: These files follow Fluent syntax and contain localized message patterns. +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 +a different locale to verify that they work. + --- ## ⚙️ Initialization From 568de289e3346142f61a0c221feddbb26ac48641 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Mon, 1 Sep 2025 23:21:42 +0200 Subject: [PATCH 2/2] doc: describe more the project --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae6f4a682..b273ff3d3 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,16 @@ cargo install coreutils ## Goals -uutils aims to be a drop-in replacement for the GNU utils. Differences with GNU +uutils coreutils aims to be a drop-in replacement for the GNU utils. Differences with GNU are treated as bugs. +Our key objectives include: +- Matching GNU's output (stdout and error code) exactly +- Better error messages +- Providing comprehensive internationalization support (UTF-8) +- Improved performances +- [Extensions](docs/src/extensions.md) when relevant (example: --progress) + uutils aims to work on as many platforms as possible, to be able to use the same utils on Linux, macOS, Windows and other platforms. This ensures, for example, that scripts can be easily transferred between platforms.