aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6a5c6799fb6fde79123b98839af00ccf5731eef0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# polecat

- *What is polecat?*
polecat is wine manager 

- *why?*
I used to use Lutris to manage installed Wine games but after
the lutris team had released a stable version with a program
breaking regression and the master branch was working as well
as a alpha branch I decided enough is enough and started working
on my own.

- *Why should I use polecat instead of X*
maybe you are tired of lutris breaking like me or maybe you
just don't want to use lutris because its a bloated python
application running GTK with [CSD](https://en.wikipedia.org/wiki/Client-side_decoration)

- *Can I help?*
If you use polecat you are already more than I could ask for
but if you want to go the extra step you can go ahead and
look at the [roadmap](https://github.com/Jan200101/polecat/issues/1) and suggest or implement things

## Dependencies

polecat depends on:

- pkg-config
- libcurl
- json-c
- libarchive
- meson

## Build instructions

- ensure you have all [dependencies](#Dependencies) installed 
- run `meson _build && ninja -C _build` for a debug build
- run `meson _build -Drelease=true && ninja -C _build` for a release build


### [License](LICENSE)

polecat is licensed under MIT so feel free to do what you want with it