Unverified Commit cec22988 authored by Katharina Fey's avatar Katharina Fey 🏴
Browse files

Updating README

parent 1bf9f8d3
# taduki
# traduki
An asset translation toolkit for Rust.
An asset translation toolkit for Rust, which compiles asset files into
the binary, but choses the appropriate translation at runtime via the
`LANG` environment locale.
Probably only works on Linux/MacOS at the moment.
```
include!(concat!(env!("OUT_DIR"), "/traduki.rs"));
fn main() {
use traduki::app;
println!("{}: {}", app::name(), app::description());
}
```
## Project state
This project is very new and developed with
[qaul.net](https://git.open-communication.net/qaul/qaul.net) as a
testing ground, as part of the Rust CLI-WG. If you have feedback,
feel free to send it to our [mailing
list](mailto:cli-wg@rust-lang.org)!
The above example accesses translation data manually, but in the
future it would be great if libraries (such as cli parsers, web
servers, etc) could also access this data to make certain integrations
easier. All of this is still very work in progress.
## The problem
We've all built applications that hade user-facing text. Whether they
are error messages, help messages, the general UI text, etc; almost
all application text can and should be translated into the user's
preferred language to make using software as accessible and easy as
We've all built applications that handle user-facing text. Whether
they are error messages, help messages, the general UI text, ...
almost all application text can and should be translated into the
user's preferred language to make using software as accessible as
possible.
However, managing translations is hard, especially when it cames to
......@@ -22,11 +49,8 @@ translated and generated with language specific texts.
## Overview
`traduki` adds the "lang-assets" directory, in which users can create
`traduki` adds a "language assets" directory, in which users can create
a losely managed structure of texts and asset files for translations.
Currently these have to be edited by hand, but it's plausible to have
a web-ui to handle translations, that can make PRs/ commits
automatically to make it easier for people to contribute.
### Asset directory structure
......@@ -57,13 +81,10 @@ assets/
│   │   ├── en_GB.yml
│   │   ├── eo.yml
│   │   └── fr_FR.yml
│   ├── default
│   │   ├── en_GB.yml
│   │   ├── eo.yml
│   │   └── fr_FR.yml
│   └── destroy
│   └── default
│   ├── en_GB.yml
│   └── eo.yml
│   ├── eo.yml
│   └── fr_FR.yml
└── manual
├── en_GB.yml
├── eo.yml
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment