1
- Project Fluent
2
- ==============
1
+ # Project Fluent
3
2
4
3
Fluent.js is a JavaScript implementation of Project Fluent, a localization
5
4
framework designed to unleash the expressive power of the natural language.
6
5
7
6
Project Fluent keeps simple things simple and makes complex things possible.
8
- The syntax used for describing translations is easy to read and understand. At
7
+ The syntax used for describing translations is easy to read and understand. At
9
8
the same time it allows, when necessary, to represent complex concepts from
10
9
natural languages like gender, plurals, conjugations, and others.
11
10
12
-
13
- Packages
14
- --------
11
+ ## Packages
15
12
16
13
Fluent.js consists of a set of packages which have different use-cases and can
17
14
be installed independently of each other.
18
15
19
- - [ @fluent/bundle ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-bundle )
20
- - [ @fluent/dedent ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dedent )
21
- - [ @fluent/dom ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dom )
22
- - [ @fluent/langneg ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-langneg )
23
- - [ @fluent/react ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-react )
24
- - [ @fluent/sequence ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-sequence )
25
- - [ @fluent/syntax ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-syntax )
16
+ - [ @fluent/bundle ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-bundle )
17
+ - [ @fluent/dedent ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dedent )
18
+ - [ @fluent/dom ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-dom )
19
+ - [ @fluent/langneg ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-langneg )
20
+ - [ @fluent/react ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-react )
21
+ - [ @fluent/sequence ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-sequence )
22
+ - [ @fluent/syntax ] ( https://github.com/projectfluent/fluent.js/tree/master/fluent-syntax )
26
23
27
24
You can install each of the above packages via ` npm ` , e.g. ` npm install @fluent/react ` .
28
25
See the end of this ` README ` for instructions on how to build ` fluent.js ` locally.
29
26
30
-
31
- Learn the FTL syntax
32
- --------------------
27
+ ## Learn the FTL syntax
33
28
34
29
FTL is a localization file format used for describing translation resources.
35
30
FTL stands for _ Fluent Translation List_ .
@@ -40,34 +35,28 @@ and others.
40
35
41
36
hello-user = Hello, { $username }!
42
37
43
- [ Read the Fluent Syntax Guide] [ ] in order to learn more about the syntax. If
38
+ [ Read the Fluent Syntax Guide] [ ] in order to learn more about the syntax. If
44
39
you're a tool author you may be interested in the formal [ EBNF grammar] [ ] .
45
40
46
- [ Read the Fluent Syntax Guide ] : https://projectfluent.org/fluent/guide/
47
- [ EBNF grammar ] : https://github.com/projectfluent/fluent/tree/master/spec
48
-
41
+ [ read the fluent syntax guide ] : https://projectfluent.org/fluent/guide/
42
+ [ ebnf grammar ] : https://github.com/projectfluent/fluent/tree/master/spec
49
43
50
- Discuss
51
- -------
44
+ ## Discuss
52
45
53
- We'd love to hear your thoughts on Project Fluent! Whether you're a localizer looking
54
- for a better way to express yourself in your language, or a developer trying to
55
- make your app localizable and multilingual, or a hacker looking for a project
46
+ We'd love to hear your thoughts on Project Fluent! Whether you're a localizer looking
47
+ for a better way to express yourself in your language, or a developer trying to
48
+ make your app localizable and multilingual, or a hacker looking for a project
56
49
to contribute to, please do get in touch!
57
50
58
- - Discourse: https://discourse.mozilla.org/c/fluent
51
+ - Discourse: https://discourse.mozilla.org/c/fluent
59
52
53
+ ## Get Involved
60
54
61
- Get Involved
62
- ------------
63
-
64
- Fluent.js is open-source, licensed under the Apache License, Version 2.0. We
65
- encourage everyone to take a look at our code and we'll listen to your
55
+ Fluent.js is open-source, licensed under the Apache License, Version 2.0. We
56
+ encourage everyone to take a look at our code and we'll listen to your
66
57
feedback.
67
58
68
-
69
- Local Development
70
- -----------------
59
+ ## Local Development
71
60
72
61
Hacking on ` fluent.js ` is easy! To quickly get started clone the repo:
73
62
0 commit comments