Skip to content

Commit 9e62af6

Browse files
authored
Configure fluent-testing for publishing (#247)
- Adds dual licence files - Adds readme - Adds appropriate metadata to Cargo.toml
1 parent 8fc7678 commit 9e62af6

File tree

6 files changed

+100
-6
lines changed

6 files changed

+100
-6
lines changed

fluent-testing/Cargo.toml

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
11
[package]
22
name = "fluent-testing"
3-
version = "0.2.0"
4-
authors = ["Zibi Braniecki <[email protected]>"]
3+
description = """
4+
A collection of mock scenarios for testing fluent-rs components.
5+
"""
6+
version = "0.0.2"
7+
authors = [
8+
"Zibi Braniecki <[email protected]>",
9+
"Erik Nordin <[email protected]>"
10+
]
511
edition = "2021"
6-
7-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
12+
homepage = "https://www.projectfluent.org"
13+
license = "Apache-2.0/MIT"
14+
repository = "https://github.com/projectfluent/fluent-rs"
15+
readme = "README.md"
16+
keywords = ["localization", "l10n", "i18n", "intl", "internationalization"]
17+
categories = ["localization", "internationalization"]
18+
include = [
19+
"src/**/*",
20+
"resources/**/*",
21+
"Cargo.toml",
22+
"README.md",
23+
"LICENSE-APACHE",
24+
"LICENSE-MIT"
25+
]
826

927
[dependencies]
1028
fluent-bundle = { version = "0.15.2", path = "../fluent-bundle" }

fluent-testing/LICENSE-APACHE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../LICENSE-APACHE

fluent-testing/LICENSE-MIT

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../LICENSE-MIT

fluent-testing/README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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)

fluent-testing/src/scenarios/empty_resource_all_locales.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use crate::queries;
66
/// effect on the ability to generate a bundle and look up other present values.
77
pub fn get_scenario() -> Scenario {
88
Scenario::new(
9-
"empty",
9+
"empty_resource_all_locales",
1010
vec![
1111
FileSource::new("browser", "browser/{locale}/", vec!["en-US", "pl"]),
1212
FileSource::new("empty", "empty-resource/{locale}/", vec!["en-US", "pl"]),

fluent-testing/src/scenarios/empty_resource_one_locale.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use crate::queries;
66
/// only for that value.
77
pub fn get_scenario() -> Scenario {
88
Scenario::new(
9-
"empty",
9+
"empty_resource_one_locale",
1010
vec![
1111
FileSource::new("browser", "browser/{locale}/", vec!["en-US", "pl"]),
1212
FileSource::new("empty", "empty-resource/{locale}/", vec!["en-US", "pl"]),

0 commit comments

Comments
 (0)