twisterarmy/twister-html
1
0
Fork 0
mirror of https://github.com/twisterarmy/twister-html.git synced 2025-03-12 13:31:14 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Nikita 2014-10-03 01:18:51 +04:00
parent 351d21c814
commit 8831c4c9a2
1 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -6,24 +6,14 @@ To use it, clone this repo under ~/.twister/html like this:
git clone https://github.com/miguelfreitas/twister-html.git ~/.twister/html git clone https://github.com/miguelfreitas/twister-html.git ~/.twister/html
**If you'r on MAC OS X - clone to ${HOME}/Library/Application\ Support/Twister/html instead of ~/.twister/html** If you'r on **Mac OS X** - clone to ${HOME}/Library/Application\ Support/Twister/html instead of ~/.twister/html
Localisation
------------
If you want a localised interface (currently available only for NL, IT, FR, DE and RU),
use the experimental `i18n` branch:
git checkout i18n
If you want to translate it in your own language, check [these instructions](#translations)
Contribute Contribute
---------- ----------
Feel free to fork and send pull requests! Feel free to fork and send pull requests!
To make it easier for us to accept your patches, please follow the conventional
GitHub workflow: To make it easier for us to accept your patches, please follow the conventional GitHub workflow:
# after forking, clone your repo # after forking, clone your repo
rm -rf ~/.twister/html rm -rf ~/.twister/html
@ -41,18 +31,16 @@ GitHub workflow:
git checkout master git checkout master
git merge upstream/master # you should get a fast-forward message here git merge upstream/master # you should get a fast-forward message here
git push git push
Translations Translations
------------ ------------
If you want to add your own translation, edit `interface_localization.js` like this: If you want to add your own translation, edit `interface_localization.js` like this:
1. fork the repo, checkout `i18n` and create a new branch 1. fork the repo and create a new branch
git clone git@github.com:yournickname/twister-html.git ~/.twister/html git clone git@github.com:yournickname/twister-html.git ~/.twister/html
cd ~/.twister/html cd ~/.twister/html
git checkout i18n
git checkout -b Klingon git checkout -b Klingon
2. add your language to the list of available choices. You should use your ISO code here, 2. add your language to the list of available choices. You should use your ISO code here,
@ -86,5 +74,4 @@ For multi-region languages, if you want to catch them all, use only the first ha
git commit -m "Klingon translation" git commit -m "Klingon translation"
git push git push
3. When opening the pull request on github, make sure you're pointing to `miguelfreitas:i18n` 3. When opening the pull request on github. For any help, ping @toyg.
as the base, so we can merge it straight away in the right place. For any help, ping @toyg.