Added CONTRIBUTING.md and BUILDING.md files
#174
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| ### Steps | ||
|
|
||
| 1. Look for the `/utils/translations` directory to find existing translations. If you don't find the language you wish to translate the application into, proceed to step 2. |
There was a problem hiding this comment.
Maybe if you didn't find the language you interested in then proceed to step 2
CONTRIBUTING.md
Outdated
|
|
||
| ### Steps | ||
|
|
||
| 1. Look for the `/utils/translations` directory to find existing translations. If you don't find the language you wish to translate the application into, proceed to step 2. |
There was a problem hiding this comment.
/utils/translations looks like an absolute unix path. Maybe ./src/utils/translations?
CONTRIBUTING.md
Outdated
|
|
||
| 1. Look for the `/utils/translations` directory to find existing translations. If you don't find the language you wish to translate the application into, proceed to step 2. | ||
|
|
||
| 2. Create a new file for the language by duplicating the `ru.ts` file in the `/translations` directory. Name it using the language code (e.g., `fr.ts` for French translations). |
There was a problem hiding this comment.
./src/utils/translations/ru.ts
CONTRIBUTING.md
Outdated
|
|
||
| 2. Create a new file for the language by duplicating the `ru.ts` file in the `/translations` directory. Name it using the language code (e.g., `fr.ts` for French translations). | ||
|
|
||
| 3. Translate the content within the file into your desired language. |
There was a problem hiding this comment.
Translate the keys into your language
CONTRIBUTING.md
Outdated
|
|
||
| 3. Translate the content within the file into your desired language. | ||
|
|
||
| 4. In the directory `/utils` open the file `translation.ts`. Import the generated file like this: |
There was a problem hiding this comment.
Import translation file in the ./src/utils/translations.ts
CONTRIBUTING.md
Outdated
| import ru from "./translations/ru"; | ||
| ``` | ||
|
|
||
| 5. Add the language to the `supportedLanguages` variable like this: |
There was a problem hiding this comment.
Add the language to the supportedLanguages map like this, to show this language in the app's menu
CONTRIBUTING.md
Outdated
| }, | ||
| ``` | ||
|
|
||
| 7. In the directory `/utils` open the file `datetime.ts`. Add the locale to the `locales` variable like this: |
There was a problem hiding this comment.
./src/utils/datetime.ts
CONTRIBUTING.md
Outdated
| ]); | ||
| ``` | ||
|
|
||
| 8. Submit a Pull Request with the translated file. |
There was a problem hiding this comment.
I'm not sure, but maybe Make a Pull Requests with the translated file?
There was a problem hiding this comment.
Okay, let's do it this way
README.md
Outdated
| @@ -50,77 +50,8 @@ See the [open issues](https://github.com/IraSoro/peri/issues) and [project](http | |||
|
|
|||
| ### How to build | |||
|
|
|||
| Install dependencies: | |||
| You can find full instruction about the project building in [BUILDING.md](https://github.com/IraSoro/peri/blob/master/BUILDING.md) file. | |||
There was a problem hiding this comment.
You can find the full instruction about the project building in
Closed #144
I added a
CONTRIBUTING.mdfile in which I described the steps for translation into new languages.I added the
BUILDING.mdfile. I moved the build information from theREADME.mdfile into it.And edited the
README.mdfile.