Skip to content

Commit

Permalink
Translation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Levminer committed Jan 30, 2022
1 parent afaaba0 commit 6c8fd82
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
34 changes: 17 additions & 17 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,16 @@

- Hi! Thanks for contributing!

1. Please use NPM, no yarn and other package managers
1. Use VS Code
1. Use ESLint and prettier extension

## Developing instructions

- Install Node.js 15+ and Git
- Install Node.js 16+ and Git
- Clone the repository `git clone https://github.com/Levminer/authme`
- Install node modules `npm i`
- Run start command: `npm run start`

## Building

- Follow Developing instructions.
- Follow Developing instructions
- Run build command: `npm run build` (You can only build for your own OS)

## NPM commands
Expand All @@ -26,17 +22,21 @@

## Contributing rules

1. Use ESLint.
1. Use Prettier.
1. Variable names: snake_case.
1. Function names: camelCase.
1. Don't use new node modules.
1. Make your PR to the dev branch.

## Before the PR

1. Read Contributing rules
1. Lint the code: `npm run lint`
1. Use NPM
1. Use VS Code
1. Use ESLint and Prettier
1. Variable names: snake_case
1. Function names: camelCase
1. Don't use new node modules
1. Make your PR to the dev branch

## Translation

- Make a copy of the languages/en.js
- Rename the file to the [two-letter country code](https://laendercode.net/en/2-letter-list.html) of the language you translating
- Also change the locale code in the 5. line to the two-letter country code
- Translate the rest of the strings
- Make a PR

## Notes

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@
- For detailed instructions check out the: [Docs](https://docs.authme.levminer.com/#/import?id=import)
- If you just want to test the app download this sample import file, unzip it, and import it to Authme: [Download](https://github.com/Levminer/authme/blob/main/sample/authme_import_sample.zip?raw=true)

## Translating

- Help translate Authme: [Translation](https://github.com/Levminer/authme/blob/main/.github/CONTRIBUTING.md#translation)
- You can translate on Crowdin to: [Crowdin](https://crowdin.com/project/authme-2fa)

## Importing

- From QR codes: You screenshot all the QR codes from your favorite websites, and import all of them to Authme
Expand Down

0 comments on commit 6c8fd82

Please sign in to comment.