-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
40 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,79 @@ | ||
QuickLauncher | ||
============= | ||
A quick menu to find and execute Maya commands and user scripts. | ||
|
||
#### Installation | ||
A minimal Qt based menu to quickly find and execute Maya commands and user scripts. | ||
|
||
> Requires Autodesk Maya 2014+ | ||
Append inner `quicklauncher` directory to PYTHONPATH. | ||
|
||
## Installation | ||
|
||
Append inner `quicklauncher` directory to your PYTHONPATH. | ||
|
||
- **Windows** | ||
|
||
```bat | ||
```bat | ||
$ cd quicklauncher | ||
$ set PYTHONPATH=%PYTHONPATH%;%CD%\quicklauncher | ||
``` | ||
|
||
- **Unix** | ||
|
||
```bash | ||
```bash | ||
# Unix | ||
$ cd quicklauncher | ||
$ export PYTHONPATH=${PYTHONPATH}:${PWD}/quicklauncher | ||
``` | ||
|
||
Or use the standard `setup.py` script. | ||
|
||
|
||
## Usage | ||
|
||
```python | ||
import quicklauncher | ||
quicklauncher.show() | ||
``` | ||
|
||
Alternatively, assign TAB key. | ||
You can also select the folder in which `quicklauncher` will look for user scripts (repo). | ||
|
||
```python | ||
import quicklauncher | ||
quicklauncher.select_repo() | ||
``` | ||
|
||
And alternatively, assign TAB key. | ||
|
||
```python | ||
import quicklauncher | ||
quicklauncher.setup_hotkey() | ||
``` | ||
|
||
Then press TAB. | ||
> Be aware that the later override Maya default behavior of the tab key jumping between inputs in the | ||
> attribute editor and editors alike. | ||
|
||
For more info (there are a few), check the [Wiki][] | ||
|
||
[Wiki]: https://github.com/csaez/quicklauncher/wiki | ||
|
||
For more info, check the [Wiki][] | ||
|
||
[Wiki]: https://github.com/mottosso/quicklauncher/wiki | ||
## Contributing | ||
|
||
#### Contributing | ||
- [Check for open issues](https://github.com/csaez/quicklauncher/issues) or open a fresh issue to | ||
start a discussion around a feature idea or a bug. | ||
|
||
- Fork the [quicklauncher repository on Github](https://github.com/csaez/quicklauncher) to start | ||
making your changes (make sure to isolate your changes in a local branch when possible). | ||
|
||
- [Check for open issues](https://github.com/csaez/quicklauncher/issues) or open a fresh issue to start a discussion around a feature idea or a bug. | ||
- Fork the [quicklauncher repository on Github](https://github.com/csaez/quicklauncher) to start making your changes (make sure to isolate your changes in a local branch when possible). | ||
- Write a test which shows that the bug was fixed or that the feature works as expected. | ||
- Send a pull request and bug the maintainer until it gets merged and | ||
published. :) | ||
|
||
Make sure to add yourself to `CONTRIBUTORS.md` | ||
- Send a pull request and bug me until it gets merged. :) | ||
|
||
|
||
Make sure to add yourself to `CONTRIBUTORS.md`! | ||
|
||
|
||
#### Limitations | ||
## Known issues | ||
|
||
- `quicklauncher` does not support MEL scripts at the moment. | ||
- `quicklauncher` does not supports MEL scripts at the moment. |