Skip to content

Commit

Permalink
Update README and provide a license
Browse files Browse the repository at this point in the history
  • Loading branch information
brentvollebregt committed Jul 9, 2018
1 parent fb52db1 commit 01783b6
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 Brent Vollebregt

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.
22 changes: 19 additions & 3 deletions README.md
Expand Up @@ -11,13 +11,24 @@
- Python : Python 2.7, 3.3 - 3.6
- Chrome : to run the user interface in; eel uses this (app mode)

### Installing
### Instillation and Usage
#### Via [PyPI](https://pypi.org/project/auto-py-to-exe/)
You can install this project using the PyPI:
```
$ pip install auto-py-to-exe
```
Now to run it, execute the following in the terminal:
```
$ auto-py-to-exe
```

#### Via [This Repository](https://github.com/brentvollebregt/auto-py-to-exe)
You can install this project using this repository by following these steps:
1. Clone/download this repo
2. Open cmd/terminal and cd to the project
3. Execute ```pip install -r requirements.txt```

## Running the Application
Run ```run.py```. Chrome will open in app mode with the project running inside.
Now to run the application, run the ```run.py``` file with python. A Chrome will open in app mode with the project running inside.

## Using the Application
1. Select your script location (paste in or use a file explorer)
Expand All @@ -34,7 +45,12 @@ Alternatively you can execute ```python run.py [filename]```. This will open up
## Video
If you need something visual to help you get started, [I made a video for the original release of this project](https://youtu.be/OZSZHmWSOeM), some things may be different but the same concepts still apply.

## Looking for the PyPI Version?
If you are looking for the PyPI version of this repo, go to [auto-py-to-exe-pypi](https://github.com/brentvollebregt/auto-py-to-exe-pypi). This repo has been preserved to keep in line with the provided video but instructions have been provided to use the new method.

## Screenshots
![Empty interface](https://i.imgur.com/dd0LC2n.png)

![Filled out](https://i.imgur.com/f3TEnZI.png)

![Converting](https://i.imgur.com/MjdONcC.png)

0 comments on commit 01783b6

Please sign in to comment.