22.1.5
by Giacomo Lacava
Create README.md |
1 |
twister-html
|
2 |
============
|
|
3 |
||
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
4 |
HTML interface for **[twister](http://twister.net.co)** (see git repo [here](https://github.com/miguelfreitas/twister-core)). It is a FOSS which is being under heavy construction. |
5 |
||
6 |
To use it, clone this repo under `~/.twister/html` like this:
|
|
22.1.5
by Giacomo Lacava
Create README.md |
7 |
|
8 |
git clone https://github.com/miguelfreitas/twister-html.git ~/.twister/html
|
|
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
9 |
|
10 |
If you're on **Mac OS X** — clone to `${HOME}/Library/Application\ Support/Twister/html` instead of `~/.twister/html` |
|
11 |
||
12 |
Be on the bleeding edge
|
|
13 |
-----------------------
|
|
14 |
||
15 |
All nightly improvements and following fixes of these improvements are tested in [blaster](https://github.com/miguelfreitas/twister-html/tree/blaster) branch. |
|
16 |
To be sure you are at the forefront, in stage of lack of testing and consensus: |
|
17 |
||
18 |
git pull && git checkout blaster
|
|
19 |
||
20 |
If you want to switch back to stable branch: |
|
21 |
||
22 |
git checkout master
|
|
23 |
||
24 |
Follow `@letstwist` in twister to be aware of recent changes. In case of getting of twister-html related buzz from it:
|
|
25 |
||
26 |
git pull
|
|
137.1.1
by Nikita
Update README.md |
27 |
|
28 |
||
22.1.5
by Giacomo Lacava
Create README.md |
29 |
Contribute
|
30 |
----------
|
|
31 |
||
32 |
Feel free to fork and send pull requests! |
|
137.1.1
by Nikita
Update README.md |
33 |
|
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
34 |
To make it easier for us to accept your patches, please follow the conventional GitHub workflow |
35 |
and keep in mind that your pull requests should have **blaster** branch as both the origin and target.
|
|
36 |
||
37 |
1. After forking, clone your repo:
|
|
38 |
||
39 |
rm -rf ~/.twister/html # in case you already have it cloned from not your repo |
|
40 |
git clone git@github.com:YOURNICKNAME/twister-html.git ~/.twister/html |
|
41 |
cd ~/.twister/html |
|
42 |
||
43 |
2. Switch to 'blaster' branch:
|
|
44 |
||
45 |
git checkout blaster |
|
46 |
||
47 |
3. CREATE A NEW BRANCH, specific to the fix you're implementing:
|
|
48 |
||
49 |
git checkout -b my-awesome-fix |
|
50 |
||
51 |
4. Make your changes.
|
|
52 |
||
53 |
5. Commit and push:
|
|
54 |
||
55 |
git commit -m "fix of #12345: bad foobarizer" && git push
|
|
56 |
||
57 |
6. Now open a pull request from branch 'YOURNICKNAME:my-awesome-fix' to 'miguelfreitas:blaster' on GitHub.
|
|
58 |
||
59 |
7. Once the request is accepted, switch back to 'blaster' and track changes in upstream repo:
|
|
60 |
||
61 |
git remote add upstream https://github.com/miguelfreitas/twister-html.git # this is one-off setup |
|
62 |
git fetch upstream && git checkout blaster |
|
63 |
git merge upstream/blaster # you should get a fast-forward message here |
|
64 |
git push |
|
137.1.1
by Nikita
Update README.md |
65 |
|
22.1.5
by Giacomo Lacava
Create README.md |
66 |
Translations
|
67 |
------------
|
|
68 |
||
69 |
If you want to add your own translation, edit `interface_localization.js` like this:
|
|
70 |
||
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
71 |
1. Fork the repo and create a new branch from 'blaster' one:
|
72 |
||
73 |
git clone git@github.com:YOURNICKNAME/twister-html.git ~/.twister/html |
|
74 |
cd ~/.twister/html && git checkout blaster |
|
75 |
git checkout -b Klingon-translation |
|
76 |
||
77 |
2. Add your language to the list of available choices. You should use your ISO code here,
|
|
78 |
it should match what the browser reports. The Klingon ISO is 'tlh', so: |
|
79 |
||
80 |
var knownLanguages = ['en', 'nl', 'it', 'fr', ... , 'ru', 'tlh'];
|
|
81 |
||
82 |
For multi-region languages, if you want to catch them all, use only the first half |
|
83 |
(e.g. to match it and it-ch, specify 'it'). |
|
84 |
||
85 |
3. Add a new wordset block after existing ones:
|
|
86 |
||
87 |
if (preferredLanguage === 'tlh') { |
|
88 |
polyglot.locale('tlh'); |
|
22.1.6
by Giacomo Lacava
Readme formatting |
89 |
wordset = { |
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
90 |
'Insults': 'mu\'qaD', |
91 |
... |
|
22.1.6
by Giacomo Lacava
Readme formatting |
92 |
} |
22.1.5
by Giacomo Lacava
Create README.md |
93 |
} |
22.1.6
by Giacomo Lacava
Readme formatting |
94 |
|
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
95 |
4. Stage all changes in file `interface_localization.js`: |
15.3.7
by basst85
Update README.md |
96 |
|
97 |
git add interface_localization.js |
|
247.3.2
by Simon Grim
update README: fix guides with 'blaster' branch related stuff |
98 |
|
99 |
5. Commit & push:
|
|
100 |
||
101 |
git commit -m 'Klingon translation' |
|
102 |
git push origin Klingon-translation |
|
103 |
||
104 |
6. Then open the pull request from branch 'YOURNICKNAME:Klingon-translation' to 'miguelfreitas:blaster' on GitHub.
|
|
105 |
||
106 |
For any help ping `@tasty` in twister.
|