|
|
@ -1,20 +1,20 @@ |
|
|
|
twister-html |
|
|
|
twister-html |
|
|
|
============ |
|
|
|
============ |
|
|
|
|
|
|
|
|
|
|
|
HTML interface for twister core. |
|
|
|
HTML interface for twister core. |
|
|
|
|
|
|
|
|
|
|
|
See git repo [here](https://github.com/twisterarmy/twister-core). |
|
|
|
See git repo [here](https://github.com/twisterarmy/twister-core). |
|
|
|
Official (currently unmaintained) [version](https://github.com/miguelfreitas/twister-core) |
|
|
|
Official (currently unmaintained) [version](https://github.com/miguelfreitas/twister-core) |
|
|
|
|
|
|
|
|
|
|
|
Stable releses available on this [page](https://github.com/twisterarmy/twister-html/releases). |
|
|
|
Stable releses available on this [page](https://github.com/twisterarmy/twister-html/releases). |
|
|
|
|
|
|
|
|
|
|
|
To use development version, clone this repo under `~/.twister/html` like this: |
|
|
|
To use development version, clone this repo under `~/.twister/html` like this: |
|
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/twisterarmy/twister-html.git ~/.twister/html |
|
|
|
git clone https://github.com/twisterarmy/twister-html.git ~/.twister/html |
|
|
|
|
|
|
|
|
|
|
|
If you're on **Mac OS X** — clone to `${HOME}/Library/Application\ Support/Twister/html` instead of `~/.twister/html` |
|
|
|
If you're on **Mac OS X** — clone to `${HOME}/Library/Application\ Support/Twister/html` instead of `~/.twister/html` |
|
|
|
|
|
|
|
|
|
|
|
Switch the edition |
|
|
|
Switch the edition |
|
|
|
----------------- |
|
|
|
----------------- |
|
|
|
|
|
|
|
|
|
|
|
TA Edition includes official Blaster updates and alternative features. To switch it, use followig commands: |
|
|
|
TA Edition includes official Blaster updates and alternative features. To switch it, use followig commands: |
|
|
@ -39,7 +39,7 @@ 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 |
|
|
|
and keep in mind that your pull requests should have **blaster** branch as both the origin and target. |
|
|
|
and keep in mind that your pull requests should have **twisterarmy** branch as both the origin and target. |
|
|
|
|
|
|
|
|
|
|
|
1. After forking, clone your repo: |
|
|
|
1. After forking, clone your repo: |
|
|
|
|
|
|
|
|
|
|
@ -47,46 +47,42 @@ and keep in mind that your pull requests should have **blaster** branch as both |
|
|
|
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 |
|
|
|
|
|
|
|
|
|
|
|
2. Switch to 'blaster' branch: |
|
|
|
2. Switch to 'twisterarmy' branch: |
|
|
|
|
|
|
|
|
|
|
|
git checkout blaster |
|
|
|
git checkout twisterarmy |
|
|
|
|
|
|
|
|
|
|
|
3. CREATE A NEW BRANCH, specific to the fix you're implementing: |
|
|
|
3. CREATE A NEW BRANCH, specific to the branch prefix and fix you're implementing: |
|
|
|
|
|
|
|
|
|
|
|
git checkout -b my-awesome-fix |
|
|
|
git checkout -b twisterarmy_my_awesome_fix |
|
|
|
|
|
|
|
|
|
|
|
4. Make your changes. |
|
|
|
4. Make your changes. |
|
|
|
|
|
|
|
|
|
|
|
5. Commit and push: |
|
|
|
5. Commit and push: |
|
|
|
|
|
|
|
|
|
|
|
git commit -m "fix of #12345: bad foobarizer" && git push --set-upstream origin my-awesome-fix |
|
|
|
git commit -m "fix of #12345: bad foobarizer" && git push --set-upstream origin twisterarmy_my_awesome_fix |
|
|
|
|
|
|
|
|
|
|
|
6. Now open a pull request from branch 'YOURNICKNAME:my-awesome-fix' to 'twisterarmy:blaster' on GitHub. |
|
|
|
6. Now open a pull request from branch 'YOURNICKNAME:twisterarmy_my_awesome_fix' to 'twisterarmy:twisterarmy' on GitHub. |
|
|
|
|
|
|
|
|
|
|
|
7. Once the request is accepted, switch back to 'blaster' and track changes in upstream repo: |
|
|
|
7. Once the request is accepted, switch back to 'twisterarmy' and track changes in upstream repo: |
|
|
|
|
|
|
|
|
|
|
|
git remote add upstream https://github.com/twisterarmy/twister-html.git # this is one-off setup |
|
|
|
git remote add upstream https://github.com/twisterarmy/twister-html.git # this is one-off setup |
|
|
|
git fetch upstream && git checkout blaster |
|
|
|
git fetch upstream && git checkout twisterarmy |
|
|
|
git merge upstream/blaster # you should get a fast-forward message here |
|
|
|
git merge upstream/twisterarmy # you should get a fast-forward message here |
|
|
|
git push |
|
|
|
git push |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
8. Alternatively, make your contribution into the official project: |
|
|
|
|
|
|
|
|
|
|
|
7. Alternatively, make your contribution into the official project: |
|
|
|
https://github.com/miguelfreitas |
|
|
|
|
|
|
|
|
|
|
|
git remote add upstream https://github.com/miguelfreitas/twister-html.git # this is one-off setup |
|
|
|
|
|
|
|
git fetch upstream && git checkout blaster |
|
|
|
|
|
|
|
git merge upstream/blaster # you should get a fast-forward message here |
|
|
|
|
|
|
|
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 and create a new branch from 'blaster' one: |
|
|
|
1. Fork the repo and create a new branch from 'twisterarmy' one: |
|
|
|
|
|
|
|
|
|
|
|
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 && git checkout blaster |
|
|
|
cd ~/.twister/html && git checkout twisterarmy |
|
|
|
git checkout -b Klingon-translation |
|
|
|
git checkout -b Klingon-translation |
|
|
|
|
|
|
|
|
|
|
|
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, |
|
|
@ -116,7 +112,7 @@ 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 origin Klingon-translation |
|
|
|
git push origin Klingon-translation |
|
|
|
|
|
|
|
|
|
|
|
6. Then open the pull request from branch 'YOURNICKNAME:Klingon-translation' to 'miguelfreitas:blaster' or 'miguelfreitas:blaster' on GitHub. |
|
|
|
6. Then open the pull request from branch 'YOURNICKNAME:Klingon-translation' to 'twisterarmy:twisterarmy' or 'twisterarmy:twisterarmy' on GitHub. |
|
|
|
|
|
|
|
|
|
|
|
[Community support](https://github.com/twisterarmy/twister-html/issues) |
|
|
|
[Community support](https://github.com/twisterarmy/twister-html/issues) |
|
|
|
[Official support](https://github.com/miguelfreitas/twister-core/issues) |
|
|
|
[Official support](https://github.com/miguelfreitas/twister-core/issues) |
|
|
|