Skip to content

Commit c71ad23

Browse files
committed
feat: update contributing guide
1 parent c2ea586 commit c71ad23

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@ If you want to add a new locale:
2929
- use [ISO 639-1](https://ru.wikipedia.org/wiki/%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA_%D0%BA%D0%BE%D0%B4%D0%BE%D0%B2_ISO_639-1) code names
3030
- create `your-lang-code.json` file in `public/translations/` and fill the translations & info
3131
- add `your-lang-code` data in `src/constants/locales.ts`
32+
- the English translations are located in `src/locales/en.json` (also read the README file in that folder)
33+
34+
### Building
35+
36+
```shell
37+
git clone https://github.com/FreesmTeam/website
38+
bun i
39+
bun dev
40+
```
3241

3342
### Repositories
3443

@@ -54,4 +63,4 @@ Thank you to all the people who have contributed!
5463

5564
<!-- Variables -->
5665

57-
[repo-card]: https://github-readme-stats.vercel.app/api/pin/?username=freesmteam&repo=freesmlauncher&bg_color=0c0c13&text_color=ffffff&title_color=f5c2e7&icon_color=f5c2e7&border_radius=8&hide_border=true
66+
[repo-card]: https://github-readme-stats.vercel.app/api/pin/?username=freesmteam&repo=freesmlauncher&bg_color=0c0c13&text_color=ffffff&title_color=f5c2e7&icon_color=f5c2e7&border_radius=8&hide_border=true

src/locales/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
This folder contains only bundled translations. You should use `/public/translations` for adding your own locale.
22

3-
Also, you need to re-select your locale if you changed translations while being in `dev` mode. This happens because translations are fetched in runtime and saved in `localStorage`.
3+
Also, you need to re-select your locale if you changed translations while being in `dev` mode. This happens because translations are fetched in runtime and cached in `localStorage`.

0 commit comments

Comments
 (0)