Skip to content

Commit

Permalink
Update README, add LICENSE file
Browse files Browse the repository at this point in the history
  • Loading branch information
artemy committed Dec 22, 2020
1 parent e14d4e1 commit 3a6e3aa
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 0 deletions.
Binary file added .readme/images/animation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Artem Makarov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
85 changes: 85 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# JetBrains projects for Alfred

![Test & release artifacts](https://github.com/artemy/alfred-jetbrains-projects/workflows/Test%20&%20release%20artifacts/badge.svg?branch=master)
![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)

Alfred workflow for opening your JetBrains IDEs projects

![image](.readme/images/screenshot.png)

## Supported IDEs

| IDE Name | Version | Keyword |
| --- | --- | --- |
| Android Studio | 4.1+ | androidstudio |
| AppCode | 2020.3+ | appcode |
| CLion | 2020.3+ | clion |
| GoLand | 2020.3+ | goland |
| IntelliJ IDEA | 2020.3+ | idea |
| PyCharm | 2020.3+ | pycharm |
| WebStorm | 2020.3+ | webstorm |

Support for older IDE versions is not guaranteed.

## Getting started

### Prerequisites

Project uses standard Python 2.7 shipped with all modern OSX distributions. No dependencies are required for running the
workflow.

### Installing

Download `*.workflow` file for your IDE from the latest release
at [Releases](https://github.com/artemy/alfred-jetbrains-projects/releases) page and open it with Alfred.

### How to Use

Open Alfred and type keyword for your IDE (see Supported IDEs above). Workflow will display list of recent projects (
sorted by time last opened descending).

You can further filter project list by typing additional words. Fuzzy first-letter search is supported (i.e.
typing `map` will find `my-awesome-project`):

![animation](.readme/images/animation.gif)

## Running the tests

Make sure to first install test dependencies:

```shell
pip install -r requirements.txt
```

To run tests, execute

```shell
python -m recent_projects_test
```

If you want to get coverage figures through `coverage` tool:

```shell
coverage run -m unittest recent_projects_test # gather test data
coverage report -m # display coverage figures
```

## Built With

* [Python 2.7](https://docs.python.org/2.7/)
* [GNU Make](https://www.gnu.org/software/make/manual/make.html) - Build scripting
* [mock](http://mock.readthedocs.org/) - Testing library
* [coverage.py](https://coverage.readthedocs.io/) - Code coverage measurement

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

See [CONTRIBUTORS.md](CONTRIBUTORS.md) and [contributors](https://github.com/your/project/contributors) for the list of
contributors.

0 comments on commit 3a6e3aa

Please sign in to comment.