Skip to content

Commit 78d3124

Browse files
committed
Update READMEs
Our READMEs on the fluent packages are lacking. Also convert to restructuredText to align with rest of docs.
1 parent 9f88c05 commit 78d3124

File tree

4 files changed

+69
-80
lines changed

4 files changed

+69
-80
lines changed

README.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

README.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Project Fluent
2+
==============
3+
4+
This is a collection of Python packages to use the `Fluent localization
5+
system <http://projectfluent.org/>`__.
6+
7+
python-fluent consists of these packages:
8+
9+
``fluent.syntax`` |fluent.syntax|
10+
---------------------------------
11+
12+
The syntax package includes the parser, serializer, and traversal
13+
utilities like Visitor and Transformer. You’re looking for this package
14+
if you work on tooling for Fluent in Python.
15+
16+
``fluent.runtime``
17+
------------------
18+
19+
The `runtime package <fluent.runtime>`__ includes the library required to use Fluent to localize
20+
your Python application. It comes with a ``Localization`` class to use,
21+
based on an implementation of bundle. It uses the tooling parser above
22+
to read Fluent files.
23+
24+
``fluent.pygments``
25+
-------------------
26+
27+
A plugin for pygments to add syntax highlighting to Sphinx.
28+
29+
Discuss
30+
-------
31+
32+
We’d love to hear your thoughts on Project Fluent! Whether you’re a
33+
localizer looking for a better way to express yourself in your language,
34+
or a developer trying to make your app localizable and multilingual, or
35+
a hacker looking for a project to contribute to, please do get in touch
36+
on the mailing list and the IRC channel.
37+
38+
- Mozilla Discourse: https://discourse.mozilla.org/c/fluent
39+
- Matrix channel:
40+
`#fluent:mozilla.org <https://chat.mozilla.org/#/room/#fluent:mozilla.org>`__
41+
42+
Get Involved
43+
------------
44+
45+
python-fluent is open-source, licensed under the Apache License, Version
46+
2.0. We encourage everyone to take a look at our code and we’ll listen
47+
to your feedback.
48+
49+
.. |fluent.syntax| image:: https://github.com/projectfluent/python-fluent/workflows/fluent.syntax/badge.svg

fluent.runtime/README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
fluent.runtime |fluent.runtime|
2+
===============================
3+
4+
Use `Fluent`_ to localize your Python application. It comes with a ``Localization``
5+
class to use, based on an implementation of bundle. It uses the parser from
6+
``fluent.syntax`` to read Fluent files.
7+
8+
.. code-block:: python
9+
10+
>>> from datetime import date
11+
>>> l10n = DemoLocalization("today-is = Today is { $today }")
12+
>>> val = l10n.format_value("today-is", {"today": date.today() })
13+
>>> val
14+
'Today is Jun 16, 2018'
15+
16+
Find the full documentation on https://projectfluent.org/python-fluent/fluent.runtime/.
17+
18+
.. _fluent: https://projectfluent.org/
19+
.. |fluent.runtime| image:: https://github.com/projectfluent/python-fluent/workflows/fluent.runtime/badge.svg

fluent.runtime/docs/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ passed through locale aware functions:
153153
154154
>>> from datetime import date
155155
>>> l10n = DemoLocalization("today-is = Today is { $today }")
156-
>>> val = bundle.format_value("today-is", {"today": date.today() })
156+
>>> val = l10n.format_value("today-is", {"today": date.today() })
157157
>>> val
158158
'Today is Jun 16, 2018'
159159

0 commit comments

Comments
 (0)