1# Fluent Syntax
2
3`fluent-syntax` is a parser/serializer API for the Fluent Syntax, part of the [Project Fluent](https://projectfluent.org/), a localization
4framework designed to unleash the entire expressive power of natural language translations.
5
6[![crates.io](http://meritbadge.herokuapp.com/fluent-syntax)](https://crates.io/crates/fluent-syntax)
7[![Build Status](https://travis-ci.org/projectfluent/fluent-rs.svg?branch=master)](https://travis-ci.org/projectfluent/fluent-rs)
8[![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=master)](https://coveralls.io/github/projectfluent/fluent-rs?branch=master)
9
10Status
11------
12
13The crate currently provides just a parser, which is tracking Fluent Syntax on its way to 1.0.
14
15Local Development
16-----------------
17
18    cargo build
19    cargo test
20    cargo bench
21
22When submitting a PR please use  [`cargo fmt`][] (nightly).
23
24[`cargo fmt`]: https://github.com/rust-lang-nursery/rustfmt
25
26
27Learn the FTL syntax
28--------------------
29
30FTL is a localization file format used for describing translation resources.
31FTL stands for _Fluent Translation List_.
32
33FTL is designed to be simple to read, but at the same time allows to represent
34complex concepts from natural languages like gender, plurals, conjugations, and
35others.
36
37    hello-user = Hello, { $username }!
38
39[Read the Fluent Syntax Guide][] in order to learn more about the syntax.  If
40you're a tool author you may be interested in the formal [EBNF grammar][].
41
42[Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/
43[EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec
44
45
46Get Involved
47------------
48
49`fluent-rs` is open-source, licensed under the Apache License, Version 2.0.  We
50encourage everyone to take a look at our code and we'll listen to your
51feedback.
52
53
54Discuss
55-------
56
57We'd love to hear your thoughts on Project Fluent! Whether you're a localizer
58looking for a better way to express yourself in your language, or a developer
59trying to make your app localizable and multilingual, or a hacker looking for
60a project to contribute to, please do get in touch on discourse and the IRC channel.
61
62 - Discourse: https://discourse.mozilla.org/c/fluent
63 - IRC channel: [irc://irc.mozilla.org/l20n](irc://irc.mozilla.org/l20n)
64