Skip to content

Commit 5f243ec

Browse files
committed
Update README
1 parent b15513e commit 5f243ec

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

README.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
11
# pyWinContext
2-
Manager for Context Menu commands in Windows, written in Python 3
2+
![](https://i.imgur.com/uqWDQ6y.png)
3+
4+
pyWinContext is a manager for custom context menus, written in Python 3,
5+
supporting Windows 7 and higher. The application allows for complete control
6+
over what filetypes to provide commands to, the text and icons they show with
7+
and the tasks that get performed on the input files.
8+
9+
![Example Configuration](https://i.imgur.com/q9oPy1d.png)
10+
11+
## Table of Contents
12+
13+
1. [Installation](#installation)
14+
2. [Command Line Options](#command-line-options)
15+
1. [Configuration Location](#configuration-location)
16+
3. [Tutorial](#tutorial)
17+
4. [License](#license)
18+
19+
## Installation
20+
21+
For people just wanting to get the application up and running, there are
22+
pre-built releases available at the link below.
23+
24+
[pyWinContext Releases](https://github.com/VodBox/pyWinContext/releases)
25+
26+
If you're installing from source, you will need to have the PyQt5 package (and
27+
cx_Freeze if you wish to build an exe) available on your system. They can
28+
easily be installed using pip.
29+
30+
```batch
31+
pip3 install pyqt5 cx_Freeze
32+
```
33+
34+
From there, you can run the application by launching launch.pyw as admin, or
35+
run the setup script to create an exe (if you have installed cx_Freeze).
36+
37+
```batch
38+
python setup.py build
39+
```
40+
41+
## Command Line Options
42+
43+
### Configuration Location
44+
45+
If you wish to have pyWinContext store it's files in a specificied directory,
46+
instead of a folder in %appdata%, you can do so by passing -c or --config, and
47+
the location of the directory in the command line.
48+
49+
```batch
50+
pyWinContext.exe -c "C:\Users\Example\pyWinContext"
51+
```
52+
53+
## Tutorial
54+
55+
TODO: Basic Tutorial...
56+
57+
## License
58+
59+
This project is licensed under the GPLv3 License - see the [LICENSE.md](LICENSE.md) file for details.

0 commit comments

Comments
 (0)