|
| 1 | +# Fluent |
| 2 | + |
| 3 | +`fluent-testing` is a collection of mock scenarios for testing fluent-rs components. |
| 4 | + |
| 5 | +Project Fluent keeps simple things simple and makes complex things possible. |
| 6 | +The syntax used for describing translations is easy to read and understand. At |
| 7 | +the same time it allows, when necessary, to represent complex concepts from |
| 8 | +natural languages like gender, plurals, conjugations, and others. |
| 9 | + |
| 10 | +[Documentation][] |
| 11 | + |
| 12 | +[Project Fluent]: https://projectfluent.org |
| 13 | +[Documentation]: https://docs.rs/fluent/ |
| 14 | + |
| 15 | +Status |
| 16 | +------ |
| 17 | + |
| 18 | +The implementation is in its early stages and supports only some of the Project |
| 19 | +Fluent's spec. Consult the [list of milestones][] for more information about |
| 20 | +release planning and scope. |
| 21 | + |
| 22 | +[list of milestones]: https://github.com/projectfluent/fluent-rs/milestones |
| 23 | + |
| 24 | + |
| 25 | +Local Development |
| 26 | +----------------- |
| 27 | + |
| 28 | + cargo build |
| 29 | + cargo test |
| 30 | + cargo run --example simple-fallback |
| 31 | + |
| 32 | +When submitting a PR please use [`cargo fmt`][] (nightly). |
| 33 | + |
| 34 | +[`cargo fmt`]: https://github.com/rust-lang-nursery/rustfmt |
| 35 | + |
| 36 | + |
| 37 | +Learn the FTL syntax |
| 38 | +-------------------- |
| 39 | + |
| 40 | +FTL is a localization file format used for describing translation resources. |
| 41 | +FTL stands for _Fluent Translation List_. |
| 42 | + |
| 43 | +FTL is designed to be simple to read, but at the same time allows to represent |
| 44 | +complex concepts from natural languages like gender, plurals, conjugations, and |
| 45 | +others. |
| 46 | + |
| 47 | + hello-user = Hello, { $username }! |
| 48 | + |
| 49 | +[Read the Fluent Syntax Guide][] in order to learn more about the syntax. If |
| 50 | +you're a tool author you may be interested in the formal [EBNF grammar][]. |
| 51 | + |
| 52 | +[Read the Fluent Syntax Guide]: https://projectfluent.org/fluent/guide/ |
| 53 | +[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec |
| 54 | + |
| 55 | + |
| 56 | +Get Involved |
| 57 | +------------ |
| 58 | + |
| 59 | +`fluent-rs` is open-source, licensed under the Apache License, Version 2.0. We |
| 60 | +encourage everyone to take a look at our code and we'll listen to your |
| 61 | +feedback. |
| 62 | + |
| 63 | + |
| 64 | +Discuss |
| 65 | +------- |
| 66 | + |
| 67 | +We'd love to hear your thoughts on Project Fluent! Whether you're a localizer |
| 68 | +looking for a better way to express yourself in your language, or a developer |
| 69 | +trying to make your app localizable and multilingual, or a hacker looking for |
| 70 | +a project to contribute to, please do get in touch on the mailing list and the |
| 71 | +IRC channel. |
| 72 | + |
| 73 | + - Discourse: https://discourse.mozilla.org/c/fluent |
| 74 | + - IRC channel: [irc://irc.mozilla.org/l20n](irc://irc.mozilla.org/l20n) |
0 commit comments