https://github.com/binaryage/totalterminal-i18n
TotalTerminal internationalization
https://github.com/binaryage/totalterminal-i18n
Last synced: 9 months ago
JSON representation
TotalTerminal internationalization
- Host: GitHub
- URL: https://github.com/binaryage/totalterminal-i18n
- Owner: binaryage
- License: other
- Created: 2011-07-19T20:27:45.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2017-01-03T22:03:10.000Z (about 9 years ago)
- Last Synced: 2025-03-26T10:52:17.257Z (10 months ago)
- Language: Ruby
- Homepage: http://totalterminal.binaryage.com
- Size: 14.2 MB
- Stars: 4
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# TotalFinder Internationalization ([totalfinder.binaryage.com](http://totalfinder.binaryage.com))
**TotalFinder** is a plugin for Apples's Finder.app which brings tabs, dual panels and more! This project gathers localizable resources.
## Do you want to translate TotalFinder into your language?
TotalFinder is not an open-source, but you should be still able to easily tweak resource files and add your preferred language.
The idea is to install TotalFinder and then sym-link its `Resources` folder to the copy of this repository where you can edit it.
When you are satisfied with your work, you should push your changes back to GitHub. I will then incorporate your work into next TotalFinder release.
You may want to read [TotalFinder opened for localization](http://blog.binaryage.com/totalfinder-localization/) blog post to get an idea why I like GitHub for this.
## Where to start?
1. Read something about git version control system. Here is [the best place to start](http://git-scm.com/documentation).
2. Get familiar with GitHub. They have also [nice docs](http://help.github.com).
3. Create GitHub user and don't forget to [setup your local git](http://help.github.com/mac-set-up-git) so your commits are linked to your GitHub account.
4. See how others are working on [TotalFinder localization](http://github.com/binaryage/totalfinder-i18n/network).
## The Workflow
### Initial step
1. [fork this project](http://help.github.com/fork-a-repo) on GitHub
2. [clone your fork](http://help.github.com/remotes) (let's assume you have it in `~/totalfinder-i18n`)
3. make sure you have [installed latest TotalFinder](http://totalfinder.binaryage.com/beta-changes) version
4. `cd ~/totalfinder-i18n` and run `./dev.sh`
### Development
1. edit files
2. validate your changes with `rake validate` (before first run execute `sudo gem install cmess` to install supporting library)
3. use `./restart.sh` to restart TotalFinder to reflect your changes
4. commit if needed - you can `./commit.sh`
5. goto 1
### Final step
1. [push to github](http://help.github.com/remotes) and send a [pull request](http://help.github.com/pull-requests)
2. (optional) run `./undev.sh` to return to unaltered TotalFinder state (this won't delete your files, it will [just unlink](totalfinder-i18n/blob/master/undev.sh) sym-linked folder)
## Questions?
### What encoding should I use for my files?
> Please use always UTF-8. Other encodings will probably fail to load or you will see wrong characters. If you are unsure please run `rake validate` task to check your files.
### I have created MYLANGUAGE.lproj and modified string files.
I've restarted the Finder.app, but I don't see my localization. What's wrong?
> And do you see Finder.app in MYLANGUAGE? First, double check you have MYLANGUAGE as top-most language in the `System Preferences > Language & Text > Language` list. Second, please note that TotalFinder is a plugin for Finder.app and it inherits preferred language from Finder.app. Finder.app does not pick MYLANGUAGE in case there is not language folder present here `/System/Library/CoreServices/Finder.app/Contents/Resources/MYLANGUAGE.lproj`. You may create empty folder by hand or you may fix this by running `sudo rake normalize` task, which will create missing folders in `/System/Library/CoreServices/Finder.app/Contents/Resources` according to language folders available in TotalFinder's Resources. Hope this helped.
### How do I keep my fork in sync with [binaryage/totalfinder-i18n](http://github.com/binaryage/totalfinder-i18n)?
> You can use the automatic sync file like this:
cd /path/to/local/git/repo
./sync.sh
> or alternatively define new remote server pointing to my repo (which will be read-only for you). Then you may pull from it and merge it into your repo as you wish.
cd /path/to/git/local/repo
Initial step: `git remote add ba git://github.com/binaryage/totalfinder-i18n.git`
Fetch + merge: `git fetch ba && git merge ba/master`
> Please note that it may end in conflict if you modified same files as I did. Please consult [git docs](http://git-scm.com/documentation) how to resolve it.
### I want to modify the UI. How can I compile XIB files?
> TotalFinder uses NIBs, to compile them from source XIBs please run `./compile.sh` (you have to have installed [XCode4 command line tools from Apple](http://developer.apple.com/technologies/tools/xcode.html))
### May I alter dimensions in the UI to fit my language?
> Although it is possible to copy XIB into language folder and make it language-specific I prefer to keep one shared XIB file for all languages. I'm using technique for defining flexible areas to fit different languages as [described here](http://code.google.com/p/google-toolbox-for-mac/wiki/UILocalization). Please see the `TotalFinder.xib` where it is already used on several places in the Preferences Window.
## Thank you!
Each contributor in [http://github.com/binaryage/totalfinder-i18n/contributors](http://github.com/binaryage/totalfinder-i18n/contributors) will get a free TotalFinder license. Please note that you will appear there with delay and only if your commits are properly recognized as authored by your github's account. You have to [setup your local git user](http://help.github.com/git-email-settings) properly.
**To be clear. Please note that:**
1. I may not accept changes in your fork
2. You are contributing your work under [MIT license](totalfinder-i18n/raw/master/license.txt)
3. You may want to explore [Network Graph](http://github.com/binaryage/totalfinder-i18n/network) to see if someone has not already been working on your language
#### License: [MIT-Style](totalfinder-i18n/raw/master/license.txt)