|
1 |
| -# wlines |
2 |
| - |
3 |
| -Dynamic menu for Windows - inspired by the [suckless](https://suckless.org/) [dmenu](https://tools.suckless.org/dmenu/). |
4 |
| - |
5 |
| -### Download |
6 |
| - |
7 |
| -~~A compiled binary for the latest commit can always be found in [Github Actions](https://github.com/JerwuQu/wlines/actions)~~. |
8 |
| - |
9 |
| -Apparently even Github Actions binaries expire, see the [Releases page](https://github.com/JerwuQu/wlines/releases) instead. |
10 |
| - |
11 |
| -### Usage |
12 |
| - |
13 |
| -Menu entries are passed to wlines through stdin. After the user has made a choice, the result is sent out through stdout. |
14 |
| - |
15 |
| -Running `(echo hello & echo world & echo !) | wlines` would for example bring up a menu like this: |
16 |
| - |
17 |
| -  |
18 |
| - |
19 |
| -The user can filter by writing in the textbox: |
20 |
| - |
21 |
| -  |
22 |
| - |
23 |
| -The menu style and behavior can be customized through command-line arguments. Run `wlines -h` for a list of these. |
24 |
| - |
25 |
| -wlines by itself doesn't do much. The power comes through using scripts that talk to it. suckless has [a list of examples of scripts that can be used with dmenu](https://tools.suckless.org/dmenu/scripts/). |
26 |
| - |
27 |
| -[Dave Davenport's](https://github.com/DaveDavenport) [rofi](https://github.com/DaveDavenport/rofi) (an alternative to dmenu) also has [such a list](https://github.com/DaveDavenport/rofi/wiki/User-scripts). |
28 |
| - |
29 |
| -### System requirements |
30 |
| - |
31 |
| -wlines has been tested and works on unmodified Windows XP (32-bit) and Windows 10 (64-bit). As such, it should work on anything in-between as well. |
32 |
| - |
33 |
| -### Build steps |
34 |
| - |
35 |
| -1. Download the [Tiny C Compiler](http://download.savannah.gnu.org/releases/tinycc/tcc-0.9.27-win32-bin.zip) and add the [WinApi headers](http://download.savannah.gnu.org/releases/tinycc/winapi-full-for-0.9.27.zip). |
36 |
| -2. Patch `tcc/lib/gdi32.def` to also include `SetDCPenColor` and `SetDCBrushColor`. |
37 |
| -3. Make sure `tcc.exe` is in your PATH. |
38 |
| -4. Clone this repo (`git clone https://github.com/JerwuQu/wlines.git`) |
39 |
| -5. Run `make.bat` |
40 |
| - |
41 |
| -### Credits |
42 |
| - |
43 |
| -* [tcc](https://bellard.org/tcc/) - by [Fabrice Bellard](https://bellard.org/) |
44 |
| - |
45 |
| -* [stretchy_buffer.h](https://github.com/nothings/stb/blob/master/stretchy_buffer.h) - by [Sean Barrett](https://github.com/nothings) |
46 |
| - |
47 |
| -### Contributing |
48 |
| - |
49 |
| -All issues and PRs related to fixing bugs or other strange behavior are welcome. |
50 |
| - |
51 |
| -### License |
52 |
| - |
53 |
| -This project is licensed under the GNU General Public License v3.0. See LICENSE for more details. |
54 |
| - |
| 1 | +# wlines |
| 2 | + |
| 3 | +Dynamic menu for Windows - inspired by the [suckless](https://suckless.org/) [dmenu](https://tools.suckless.org/dmenu/). |
| 4 | + |
| 5 | +### Download |
| 6 | + |
| 7 | +See the [Releases page](https://github.com/JerwuQu/wlines/releases). |
| 8 | + |
| 9 | +### Usage |
| 10 | + |
| 11 | +Menu entries are passed to wlines through stdin. After the user has made a choice, the result is sent out through stdout. |
| 12 | + |
| 13 | +The menu style and behavior can be customized through command-line arguments. Run `wlines -h` for a list of these. |
| 14 | + |
| 15 | +wlines by itself doesn't do much. The power comes through using scripts that talk to it. suckless has [a list of examples of scripts that can be used with dmenu](https://tools.suckless.org/dmenu/scripts/). |
| 16 | + |
| 17 | +[Dave Davenport's](https://github.com/DaveDavenport) [rofi](https://github.com/DaveDavenport/rofi) (an alternative to dmenu) also has [such a list](https://github.com/DaveDavenport/rofi/wiki/User-scripts). |
| 18 | + |
| 19 | +### Build steps |
| 20 | + |
| 21 | +In a MinGW environment you can simply run `make` (e.g. `x86_64-w64-mingw32-make`). |
| 22 | + |
| 23 | +See [the Github Actions Workflow](https://github.com/JerwuQu/wlines/blob/master/.github/workflows/build.yml) for a complete example. |
| 24 | + |
| 25 | +### License |
| 26 | + |
| 27 | +This project is licensed under the GNU General Public License v3.0. See LICENSE for more details. |
0 commit comments