Skip to content

Commit 024c427

Browse files
committed
add readme
fix format on translations.md
1 parent af5e719 commit 024c427

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Official Masari Project Website
2+
3+
![travis build status](https://travis-ci.org/masari-project/masari-project.github.io.svg?branch=development)
4+
5+
Visit the Official Masari Project Website at [https://getmasari.org](https://getmasari.org).
6+
7+
The Masari Project website is 100% open source and is available for any one to edit. Basic knowledge of HTML, CSS, Markdown and Jekyll may be needed.
8+
9+
To make changes, simply fork our repository, create a new branch based on our `development` branch and then submit a Pull Request with the changes.
10+
11+
## Building locally
12+
13+
To build the Masari Project website on your local system, you will need to set up [Jekyll](https://jekyllrb.com/). As Jekyll as other requirements, we suggest that you follow publicly available guides to set up Jekyll on your desired system.
14+
15+
## Site Translations
16+
17+
We encourage any one who can translate from English to their native language to please do so. For instructions on translating the Masari Project website, please refer to [our translations readme](TRANSLATIONS.md).
18+
19+
## Site Issues
20+
21+
Are you experiencing a viewing issue on the website? We encourage you to open an [issue](https://github.com/masari-project/masari-project.github.io/issues/new). For more immediate assistance, visit us on [Discord](https://discord.gg/sMCwMqs) and make your statement in the #development channel.
22+
23+
### Kudos
24+
- @camthegeek - new website
25+
- @jeutheidit - Content writer
26+
- @xiaomogwai - Testing on Mac
27+
- Kudos to many others for testing and providing feedback!

TRANSLATIONS.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
**Translating the Masari website**
1+
# Translating the Masari Project website
22

33
English is the primary language across multiple projects worldwide. All translations should be based upon their English version.
44

5-
***First Step***
5+
## First Step
6+
67
The first file you should focus on translating will be located here:
78
- _i18n/en.yml
89

910
Copy this file and rename it to your desired language code. Example: fr.yml would be great for French translation. In this file, be sure to add your language code and full language name under `Language:`.
1011

11-
*** Second Step ***
12+
## Second Step
13+
1214
The next step is to add your language to the site configuration file. This is located in the main directory and is titled `_config.yml`. Find the area in `_config.yml` that contains `languages:`. Add your language. Example: `languages: ["en", "fr"]`. Each language will be wrapped in quotes and will be seperated by commas.
1315

14-
*** Third Step ***
16+
## Third Step
17+
1518
The Masari website was designed and developed to have sections that can easily be edited, updated, removed and translated in an organized manner. This allows us to have a more flexible content website.
1619

1720
The following files should also be translated. These files contain content for the RESEARCH CORNER, RESOURCES and ROADMAP sections. The content in DOWNLOADS should be fine as is. In the RESOURCES file, only the name field will need to be translated.
@@ -41,9 +44,13 @@ The following files should also be translated. These files contain content for t
4144

4245
After translating the above files, the majority of the front page content should be translated.
4346

44-
*** Fourth Step ***
47+
## Fourth Step
4548
Now that all the content has been translated, we will need to add your language to the website navigation. This will require opening `_includes/header.html`. Near the bottom of this file, you will find a line such as `<a href="/">{% t language.en %}</a>`. Change this line around a bit to match your language. Using our French example, we would add the following: `<a href="/fr">{% t language.fr %}</a>`. If other languages are listed, add your new language at the end of the listed languages.
4649

47-
*** Additional information ***
50+
### Additional information
4851

4952
The Masari guides are pulled from an external repository at this current time. Accessing our site at /guides will result in English only content (but will have everything else translated). You may submit a pull request on the (https://github.com/masari-project/masari-marketing)[masari-marketing] repository for your desired language.
53+
54+
### Questions?
55+
56+
Should you have questions, we encourage you to open an [issue](https://github.com/masari-project/masari-project.github.io/issues/new). For more immediate assistance, visit us on [Discord](https://discord.gg/sMCwMqs) and make your statement in the #development channel.

0 commit comments

Comments
 (0)