BlueQuartzSoftware / BlueQuartzSoftware/simplnx

DOC: Offer README.md Language Translations

Open
#714 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
C++
Stars
17
Forks
13
Avg merge
3d 4h
Merged PRs (30d)
10

Description

The `README.md` needs to be translated to support as many languages as possible.

See [this table of locales](https://docs.moodle.org/dev/Table_of_locales) for ideas on `.lang` naming scheme

The steps for doing so are as follows:

1. Create a new `README.lang.md` at the root level | Example: For international Spanish it would be `README.es.md`
2. Translate the README.md to selected language, excluding the following:

```text
USAF Contract _FA8650-22-C-5290_
```

and

```text
AFRL has completed the review process for your case on 14 Sep 2022:

Subject: DREAM3D_Project (O) Shah #-11 (Software Code)

Originator Reference Number: RX22-0852
Case Reviewer: M. Allen
Case Number: AFRL-2022-4403

The material was assigned a clearance of CLEARED on 14 Sep 2022.
```

3. Update the table at the top of the new `README.md` to include the link to your README.lang.md | Example:

```markdown
| Language | [English](https://github.com/BlueQuartzSoftware/complex/blob/develop/README.md) | [Español](https://github.com/BlueQuartzSoftware/complex/blob/develop/README.es.md) |
| -------- | ------------------------------------------------------------------------------- | ----------- |
```

4. Put in a pull request from your fork to our `develop` branch, see `CONTRIBUTING.md` in root for more information

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.