Permalink
Browse files

README.md: update

  • Loading branch information...
austin987 committed Aug 21, 2017
1 parent b5a0048 commit 9fe62fc9ad849619edc0b40f07c05e68534c1f81
Showing with 44 additions and 10 deletions.
  1. +44 −10 README.md
View
@@ -11,41 +11,75 @@ https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks
Tagged releases are accessible here:
https://github.com/Winetricks/winetricks/releases
# Installing
If available and up to date, you should use the ```winetricks``` package, available in most distributions:
* Arch: https://www.archlinux.org/packages/community/any/winetricks/
* Debian: https://packages.debian.org/sid/winetricks
* Fedora: https://fedoraproject.org/wiki/Wine#Packages
* Gentoo: https://packages.gentoo.org/packages/app-emulation/winetricks
* Homebrew (OSX): http://brewformulas.org/Winetricks
* MacPorts (OSX): https://www.macports.org/ports.php?by=name&substr=winetricks
* Ubuntu: https://packages.ubuntu.com/search?keywords=winetricks Note: Ubuntu LTS versions are years out of date, do a manual install instead.
If it's not available, outdated (e.g., Ubuntu LTSs), or you want the bleeding edge version, you can manually install winetricks:
```
wget https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks
chmod +x winetricks
sudo mv winetricks /usr/local/bin
```
or if you don't have wget, you can use curl:
```
curl -O https://raw.githubusercontent.com/Winetricks/winetricks/master/src/winetricks
chmod +x winetricks
sudo mv winetricks /usr/local/bin
```
Note: /usr/local/bin must be in your $PATH for this to work.
You can then keep winetricks up to date in the future by doing:
```
winetricks --self-update
```
# Custom .verb files
You can pass winetricks a custom .verb (format below), that can be used to add new dlls/settings/programs.
Example `icecat.verb`:
```
w_metadata icecat apps \
title="GNU Icecat 31.7.0" \
title="GNU Icecat 38.8.0" \
publisher="GNU Foundation" \
year="2016" \
media="download" \
file1="icecat-31.7.0.en-US.win32.zip" \
installed_exe1="$W_PROGRAMS_X86_WIN/icecat/icecat.exe"
file1="icecat-38.8.0.en-US.win32.zip" \
installed_exe1="${W_PROGRAMS_X86_WIN}/icecat/icecat.exe"
load_iceweasel()
load_icecat()
{
w_download https://ftp.gnu.org/gnu/gnuzilla/38.8.0/icecat-38.8.0.en-US.win32.zip b9f49144f07044f12afc390acb36bf93e174e199
w_download https://ftp.gnu.org/gnu/gnuzilla/38.8.0/${file1} e5f9481e78710c25eb3a271d81aceb19ef44ff6e8599da7d5f7a2da584c01213
w_try_unzip "${W_PROGRAMS_X86_UNIX}" "${W_CACHE}/${W_PACKAGE}/${file1}"
}
```
Note that the filename and command name (icecat) must match. All metadata fields are optional, only command name and category required.
Note that the file prefix (icecat.verb) and command name (icecat) must match. All metadata fields are optional, only command name and category required.
# Tests
The tests need `bashate`, `checkbashisms`, and `shellcheck>=0.4.4` installed.
Makefile supports a few test targets:
* check - runs './tests/winetricks-tests quick' (without first clearing $WINETRICKS_CACHE)
* shell-checks - runs './tests/shell-checks'
* test - runs './tests/winetricks-tests full' (and clears $WINETRICKS_CACHE first)
* xvfb-check - runs './tests/winetricks-tests xvfb-check' (without first clearing $WINETRICKS_CACHE first)
# Support
* Winetricks is maintained by Austin English <austinenglish!$gmail.com>.
* Winetricks is maintained by Austin English <austinenglish@gmail.com>.
* If winetricks has helped you out, then please consider donating to the FSF/EFF as a thank you:
* EFF - https://supporters.eff.org/donate/button
* FSF - https://my.fsf.org/donate
* Donations towards electricity bill and developer beer fund can be sent via Bitcoin to 18euSAZztpZ9wcN6xZS3vtNnE1azf8niDk
* Donations towards electricity bill and developer beer fund can be sent via Bitcoin to 18euSAZztpZ9wcN6xZS3vtNnE1azf8niDk
* I try to actively respond to bugs and pull requests on GitHub:
* Bugs: https://github.com/Winetricks/winetricks/issues/new
* Pull Requests: https://github.com/Winetricks/winetricks/pulls
* Bugs: https://github.com/Winetricks/winetricks/issues/new
* Pull Requests: https://github.com/Winetricks/winetricks/pulls

0 comments on commit 9fe62fc

Please sign in to comment.