somehow i never included a readme

This commit is contained in:
Nicholas O'Connor 2017-04-12 11:27:14 -07:00
parent db813a7d7b
commit c202f5ad1d
2 changed files with 38 additions and 1 deletions

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# cellar
### bottle management tool for WINE connoisseurs
## Installation
```sh
$ mkdir build && cd build
$ cmake ..
$ make -j4
$ sudo make install
```
## Quick Usage Primer
```sh
$ cellar create steam
$ cellar -b steam winetricks vcrun2012
# without the -b argument, cellar assumes you want to deal with ~/.wine
# you can manage which bottle that points to with this command
$ cellar activate steam
# arguments passed to "cellar launch" are passed to wine
$ cellar launch /mnt/windows/Steam/Steam.exe
```
## Features
* **Corking**: Saves a bottle's configuration, including any pressed installers (see below) or installed winetricks, to a directory, then removes the WINE bottle from disk.
You can then easily rebuild that WINE bottle later by uncorking it, which will automatically rebuild the WINE bottle with your active (or specified) version of WINE, as
well as install any saved winetricks or run any pressed installers.
* **Pressed Installers**: Saves a copy of an installer to `~/.cellar`, writes it down in the bottle configuration, then runs it within your WINE bottle. If you choose to
cork this bottle later, this installer will automatically be run after uncorking. If the installer comes with "unattended install" arguments, it's recommended you press
those in too.
* **Easy WINE and bottle management**: Need a specific bottle for a specific program? `cellar -b bottlename <command>`. Does the bottle need to run a specific instance of
WINE? `cellar config wine_path /opt/wine-specific/bin/wine`. Confused about which bottle is "active"? `cellar active` will tell you. Different programs may need drastically
different WINE configurations, but that doesn't mean you need the drastic headaches.
## License
Cellar is available under (the MIT license)[LICENSE].

2
cogrc
View File

@ -1,3 +1,3 @@
[version]
release=no
release_version=0.2
release_version=0.3