Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Further tidyups

  • Loading branch information...
commit 2f375df56f586810bd6bb479b129e3ddd999cd04 1 parent 1e33a48
@pjrobertson pjrobertson authored
Showing with 14 additions and 67 deletions.
  1. +14 −67 README.markdown
View
81 README.markdown
@@ -3,24 +3,23 @@ About Quicksilver ß6X on Github
This repository contains the current source code of Quicksilver. If you're having issues with the latest Quicksilver version, feel free to log them at the [issue tracker](https://github.com/quicksilver/Quicksilver/issues).
-This branch contains the source for the currently released Quicksilver.
-The alcor branch contains the code for the "next-gen" Quicksilver. Right now it features an updated plugin system, and Catalyst, which aims to provide triggers as a preference pane, and that's it. It is usable, but all plugins are incompatible without some extra work.
+This master branch contains the source for the currently released Quicksilver.
+The alcor branch contains the code for the "next-gen" Quicksilver. Right now it features an updated plugin system, and Catalyst, which aims to provide triggers as a preference pane, and that's it. It is usable, but all plugins are incompatible without some extra work. There are currently no plans to ever release this version.
-If you want more info about [Quicksilver](QSapp.com) you can read about it on [Wikipedia](http://en.wikipedia.org/wiki/Quicksilver_%28software%29 "Quicksilver Wikipedia article"), or
-just do a search on YouTube - there's tons of very helpful instructional and informational video tutorials.
-Or visit the [mailing list](http://groups.google.com/group/blacktree-quicksilver "Quicksilver Google Group") hosted at Google Groups.
+If you want more info about [Quicksilver](http://qsapp.com) you can read the [about page](http://qsapp.com/about.php) or view it on [Wikipedia](http://en.wikipedia.org/wiki/Quicksilver_%28software%29 "Quicksilver Wikipedia article").
+For help and support, visit the [Quicksilver Support Group](http://groups.google.com/group/blacktree-quicksilver "Quicksilver Google Group"). Developers can find help in the [Developer Support Group](https://groups.google.com/forum/?hl=en_US&fromgroups#!forum/quicksilver---development)
-Where to find it ?
----------------------
+Where to download Quicksilver?
+------------------------------
Visit [QSApp.com](http://qsapp.com/download.php), and download the right version for your operating system.
-Before You Try It Out
----------------------
+Before Trying the Source Code
+-----------------------------
-Before trying out new Quicksilver versions, **ALWAYS BACKUP** your user data!
+Before building and testing Quicksilver, **ALWAYS BACKUP** your user data!
This is easily done by backing up the following 2 folders and preference file:
(`<user>` stands for your short user name):
@@ -29,40 +28,22 @@ This is easily done by backing up the following 2 folders and preference file:
`/Users/<user>/Library/Caches/Quicksilver`
`/Users/<user>/Library/Preferences/com.blacktree.Quicksilver.plist`
-And just to be safe, you might want to backup the present
-
-`/Applications/Quicksilver.app`
-
-before you overwrite it with this version.
-
-The following commands should make it easy to save these files into a backup [tarball](http://en.wikipedia.org/wiki/Tar_%28file_format%29):
-
- QS_BACKUP_FILE=$(date "+Quicksilver Backup on %Y-%m-%d at %H-%M-%S")
- tar -czf "${QS_BACKUP_FILE}.tgz" \
- "${HOME}/Library/Application Support/Quicksilver" \
- "${HOME}/Library/Caches/Quicksilver" \
- "${HOME}/Library/Preferences/com.blacktree.Quicksilver.plist" \
- "/Applications/Quicksilver.app"
-
Now if anything happens you can always restore the exact state Quicksilver was in before
your were trying out this version.
-Facts, Features and Fixes
--------------------------
+Notice on version compatibility
+-------------------------------
- Minimum runtime requirement for this version is Mac OS X 10.6 ("Leopard").
+ Minimum runtime requirement for this version is Mac OS X 10.6 ("Snow Leopard").
Notes Specific to Snow Leopard and Lion
---------------------------------------
-Snow Leopard has a reworked Services system. This is relevant because preferences like *"Pull selection from front application instead of Finder"* (`Preferences > Extras`) make use of two services called *"Get Current Selection"* and *"Send to Quicksilver"*.
+The Services System in OS X will not register properly when the pasteboard server (`/System/Library/CoreServices/pbs`) sees multiple Quicksilver.app packages each with their very own Info.plist file defining the same services.
-It appears that these services will not register properly when the pasteboard server (`/System/Library/CoreServices/pbs`) sees multiple Quicksilver.app packages each with their very own Info.plist file defining the same services.
-
-The result is that none of the services for any Quicksilver.app will register and thus the default Cmd + Esc hotkey combo won't do anything much no matter which application is currrently frontmost.
-The solution to this is to zip any old Quicksilver.app packages you want to keep around and delete every Quicksilver.app package except the one you want to run.
+In order to ensure that the Service System works correctly, zip any old Quicksilver.app packages you want to keep, so you only have one Quicksilver.app file on your filesystem.
Also do not forget to empty your trash after you deleted the older Quicksilver.app packages.
@@ -72,37 +53,6 @@ Development
You should be able to build Quicksilver after following the instructions as seen in the Quicksilver Wiki on [Building Quicksilver](http://qsapp.com/wiki/Building_Quicksilver). Be aware that the build system **will overwrite** the Quicksilver located in your /Applications folder.
-A Few Notes on Working With Git
--------------------------------
-
-The following (non-exhaustive) list shows files which need to be treated specially within git:
-
-`Quicksilver/PlugIns-Main/Bezel/Info.plist`
-`Quicksilver/PlugIns-Main/Finder/Info.plist`
-`Quicksilver/PlugIns-Main/PrimerInterface/Info.plist`
-`Quicksilver/PlugIns-Main/QSHotKeyPlugIn/Info.plist`
-
-That is because they change each time the project is built (e.g. the hexadecimal build number is updated by 'bltrversion' for each plugin).
-
-We can't just remove them from the project and add them to the repository-wide .gitignore file because we still need to push those files up to the remote so that another developer will get them when he/she clones the project.
-Also because this project was converted from SVN we can't just tell everyone to add those files to their personal repository-wide exclude file (in .git/info/exclude) and be done with it. If the file is already tracked adding it to any ignore file won't keep git from tracking it (gitignore(5) has more info on that).
-
-What we need is to tell git to just keep the initial version in the repository but not track any changes.
-The following commands seem to do just that:
-
-`git update-index --assume-unchanged Quicksilver/PlugIns-Main/Bezel/Info.plist`
-`git update-index --assume-unchanged Quicksilver/PlugIns-Main/Finder/Info.plist`
-`git update-index --assume-unchanged Quicksilver/PlugIns-Main/PrimerInterface/Info.plist`
-`git update-index --assume-unchanged Quicksilver/PlugIns-Main/QSHotKeyPlugIn/Info.plist`
-
-This will keep git from noticing any changes but will still keep it (do a `git-ls-files | grep QSHotKeyPlugIn/Info.plist` to confirm).
-
-If you need to make changes to any of those files and you need these changes visible for others to clone then you must revert the commands issued above before commiting.
-To do so just run the commands again but this time with `--no-assume-unchanged`.
-
-PS.: If any of the git veterans has a better way of handling this please send me a message to my (andreberg) github inbox.
-
-
Legal Stuff
-----------
@@ -119,6 +69,3 @@ By downloading and/or using this software you agree to the following terms of us
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
-
-Which basically means: whatever you do, I can't be held accountable if something breaks.

2 comments on commit 2f375df

@lgarron

Argh, I was looking for the usual precautionary backup commands, and found they were gone. I tried blame, so here I am... blaming you? :-P
(Probably better to have a simpler README, though.)

@pjrobertson

We're trying to move everything over to the wiki now. Backup info is here:

http://qsapp.com/wiki/FAQ#How_to_Backup_or_Reset_Quicksilver.27s_Settings

Please sign in to comment.
Something went wrong with that request. Please try again.