Skip to content

Commit

Permalink
Added README content, build
Browse files Browse the repository at this point in the history
  • Loading branch information
bantya committed Mar 19, 2019
1 parent 05344b7 commit fbb3d0f
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 34 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.vscode
make.cmd
build
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 <copyright holders>
Copyright (c) 2019 Rahul Thakare <https://github.com/bantya>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
69 changes: 46 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@
This is Command, a plugin for the
[Keypirinha](http://keypirinha.com) launcher.

**TODO:** write a brief description of this package. Optionally add a
screenshot.
This package provides an easy way to execute simple commands from launcher.

![Command usage](./images/demo.gif "Command usage")

## Download

**TODO:** indicate where the latest `.keypirinha-package` file can be
downloaded. For example a URL to the `releases` list like:
https://github.com/USERNAME/keypirinha-PACKAGE/releases
Download the plugin file from [here](https://github.com/bantya/Keypirinha-Command/releases).


## Install
Expand All @@ -24,47 +22,72 @@ move it to the `InstalledPackage` folder located at:
final path would look like
`C:\Users\%USERNAME%\AppData\Roaming\Keypirinha\InstalledPackages`)

## Configuration
0. There is no configuration required. If you want you can proceed to **Step 1**.

1. Open the `Command` config file.

![Command config](./images/config.png "Command config")

2. Set `close_cmd`.

![Command files](./images/files.png "Command files")

The possible values are:

- `yes`: Close the command prompt after executing the command.
- `no`: Keep the command prompt open. (Default)

## Usage

**TODO:** list the items, if any, inserted to the Catalog by the plugin(s) of
this package. Some plugins only make suggestions, in which case a description of
what kind of suggestions are to be expected by the user may help.
![Command usage](./images/usage.png "Command usage")

Invoke Keypirinha and put the command to be executed in following format:
```
> [command (can contain spaces)]
## Change Log
**TODO:** describe notable changes for each release. Below is a template for
version 1.0.
e.g.
> ping google.com -> This will open the command prompt and ping google.com
```

### Actions

There are two actions available irrespective of the configuration.

![Command actions](./images/actions.png "Command actions")

- **Keep Open**: Do not close the prompt after running the command.
- **Close CMD**: Close the prompt after running the command.

## Change Log

### v1.0

* Added foo item
* Fixed bug that was doing bad things when item "bar" was selected
* Initial release.
* Added actions.


## License

**TODO:** recommended section. Below is an example that goes with the default
LICENSE file (MIT license). Do not forget to add your name in the `LICENSE`
file!

This package is distributed under the terms of the MIT license.
MIT, that's it.


## Credits

**TODO:** optional section.
*Waiting for the first name to appear here.*


## Contribute

**TODO:** optional section. Below is a template example, based on the one found
in Keypirinha's Packages repository.

Here is how to contribute:
1. Check for open issues or open a fresh issue to start a discussion around a
feature idea or a bug.
2. Fork this repository on GitHub to start making your changes to the **dev**
branch.
3. Send a pull request.
4. Add yourself to the *Contributors* section below (or create it if needed)!


## Anything else?
No, Thanks to all.
Binary file added command.ico
Binary file not shown.
Binary file added images/actions.png
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 images/config.png
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 images/demo.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 images/files.png
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 images/usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 4 additions & 10 deletions src/command.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,12 @@
# More info at http://keypirinha.com
#

# NOTE TO PLUGIN DEVELOPER:
# * This file may be removed from the package if no plugin requires
# configuration
# * The [main] section below is an example and not mandatory, however it is good
# practice to keep the [var] and [env] sections, as well as their respective
# comments
# * This comment block may be removed!

[main]
# Plugin's main configuration section

#
# * close_cmd
# Close the command prompt after executing a command.
# dafault = no

[var]
# As in every Keypirinha's configuration file, you may optionally include a
Expand All @@ -32,7 +27,6 @@
#
# See the "Configuration" chapter of the documentation for more information.


[env]
# For convenience, Keypirinha populates this [env] section in every loaded
# configuration file so you can easily access to environment variables like
Expand Down

0 comments on commit fbb3d0f

Please sign in to comment.