VeniVidiVici
/
logisim-evolution
mirror of https://github.com/logisim-evolution/logisim-evolution.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix some typos in localization.md

This commit is contained in:
Torsten Maehne 2023-01-05 11:25:21 +01:00
parent 481641a65c
commit cb971a79db
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/localization.md
View File

@ -17,7 +17,7 @@ In the path `src/main/resources/resources/logisim/` folder you will find the lan
application strings translated for specific language.
Each of these files contain content following `key = value` format, where the `key` is the string identifier used by the application
to obtain given string and therefore it **MUST** stay unaltered and the `value` is the text in the specific language. You can also
to obtain given string, and therefore it **MUST** stay unaltered and the `value` is the text in the specific language. You can also
fine entry starting with `#` which indicates comment line (these, if found, should not be translated because it may be lost in
further automated processing anyway). You will however more often encounter lines like:
@ -33,13 +33,13 @@ or
This line is automatically generated by `trans-tool` utility (see below) and it means that a language specific translation of `key`
available and that at runtime, `Logisim-evolution` takes the default (English) value for this key instead. Once you translate this
line, make sure you incomment it (by removing `# ==>`) too.
line, make sure you uncomment it (by removing `# ==>`) too.
# Adding new translation #
To add new, non yet existing language version you will need to create `*.properties` files for your language but also add your
language code to `src/main/resources/resources/logisim/settings.properties`. Please create new ticket if you are willing to
contribute new language version but please ensure you got sufficient man-power to do that first, as there's a lot of text to
contribute new language version, but please ensure you got sufficient man-power to do that first, as there's a lot of text to
translate.
---
@ -69,14 +69,14 @@ folder for alternative scripts):
$ source venv/bin/activate
```
Now, while in venv active, install the trans-tool:
Now, while in the active venv, install the trans-tool:
```bash
$ pip install trans-tool
```
Now you should have `trans-tool` (and `transtool` too, same binary, just name alias) in your path. **Remember that you always need
go activate venv prior use in new session/terminal/after reboot/etc.**
to activate the venv prior use in new session/terminal/after reboot/etc.**
Go to Logisim's source code root folder and create a small bash script (i.e. `scan.sh`) with this content:
@ -107,8 +107,8 @@ and run
$ ./scan.sh
```
if you prefer working on single files untill you done, you can replace invocation of `trans-tool` with just `echo "${f}"` (and
remove `read`) so it will print all base files found. And the invoke `trans-tool` manually (where `-l` specifies your language code
If you prefer working on single files until you are done, you can replace the invocation of `trans-tool` with just `echo "${f}"` (and
remove `read`) so it will print all base files found. Invoke `trans-tool` manually (where `-l` specifies your language code
and `-b` points to base file(s)):
```bash
@ -146,7 +146,7 @@ folder as base one, so we need just update it:
$ trans-tool -l pl -b src/main/resources/resources/logisim/strings/soc/soc.properties -wr
```
the `-wr` is short form for `--write-ref` option.
The `-wr` is short form for `--write-ref` option.
If you have no translation file but would like from scratch, using `--write`, `--write-contents` or `--write-ref` options will
create template file for you:
@ -159,7 +159,7 @@ $ trans-tool -l pl -b src/main/resources/resources/logisim/strings/soc/soc.prope
Some issues `trans-tool` reports (even as errors) are still "false positives" as not all validators are perfectly tuned (or smart
enough yet), so feel free to consider program report as "improvement suggestions" and investigate the reported problems and judge
yourself you want to fix it or not. Feel free to suggest an [improvements](https://github.com/MarcinOrlowski/trans-tool/issues) to
yourself you want to fix it or not. Feel free to suggest [improvements](https://github.com/MarcinOrlowski/trans-tool/issues) to
default configuration tweaks.
# Issues #