Skip to content

Commit

Permalink
cleanup and housekeeping
Browse files Browse the repository at this point in the history
  • Loading branch information
csaez committed Aug 15, 2016
1 parent 18c632d commit 76f6b6c
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 30 deletions.
14 changes: 2 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
#############
## Python
#############

# Python
*.py[co]

# Packages
Expand All @@ -26,12 +23,5 @@ pip-log.txt
#Translations
*.mo

#Mr Developer
.mr.developer.cfg

#Virtualenv
env/

#vim
.ropeproject
*/.ropeproject
venv/
1 change: 0 additions & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@

* Marcus Ottosson (mottosso)
- Added TAB-key for activation of window
- Refactored API so as to not leak into implementation
55 changes: 38 additions & 17 deletions README.md
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.

0 comments on commit 76f6b6c

Please sign in to comment.