From 3e8756078d5ef9d56182e70527efd6d7c556894a Mon Sep 17 00:00:00 2001 From: Sebastian Lackner Date: Wed, 30 Jul 2014 04:31:51 +0200 Subject: [PATCH] Wine-Compholio is a name, so it should start everywhere with captial letter W and C. --- DEVELOPER.md | 18 ++++++++--------- README.md | 38 ++++++++++++++++++------------------ debian/tools/DEVELOPER.md.in | 18 ++++++++--------- debian/tools/README.md.in | 38 ++++++++++++++++++------------------ 4 files changed, 56 insertions(+), 56 deletions(-) diff --git a/DEVELOPER.md b/DEVELOPER.md index 47b10107..6063c810 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -2,16 +2,16 @@ Developers and maintainers guide ================================ This document will provide some information targeted at developers, who -either want to build/package wine-compholio for their distribution, but also -for developers who would like to contribute their patches to wine-compholio, +either want to build/package Wine-Compholio for their distribution, but also +for developers who would like to contribute their patches to Wine-Compholio, to get them included in future releases. -Compiling wine-compholio +Compiling Wine-Compholio ======================== -**Warning:** Please note that starting with wine-compholio 1.7.23 it is +**Warning:** Please note that starting with Wine-Compholio 1.7.23 it is deprecated to manually apply patches without using the Makefile. To avoid typical pitfalls for package maintainers (like trying to use the patch commandline utility for binary patches or not updating the patchlist) it is @@ -26,7 +26,7 @@ Instructions The following instructions (based on the [Gentoo Wiki](https://wiki.gentoo.org/wiki/Netflix/Pipelight#Compiling_manually)) -will give a short overview how to compile wine-compholio, but of course not +will give a short overview how to compile Wine-Compholio, but of course not explain all details. Make sure to install all required Wine dependencies before proceeding. @@ -49,7 +49,7 @@ make -C ./patches DESTDIR=$(pwd) install ``` Afterwards run configure (you can also specify a prefix if you don't want to install -wine-compholio system-wide): +Wine-Compholio system-wide): ```bash ./configure --with-xattr ``` @@ -93,11 +93,11 @@ make -C ./patches DESTDIR=$(pwd) PATCHLIST="DIRNAME1.ok DIRNAME2.ok" install ``` -Contributing to wine-compholio +Contributing to Wine-Compholio ============================== -Please note that wine-compholio is not just an arbitrary collection of Wine -patches. We see wine-compholio as a **testing version** in preparation for +Please note that Wine-Compholio is not just an arbitrary collection of Wine +patches. We see Wine-Compholio as a **testing version** in preparation for patches to be submitted to upstream Wine. This implies that all patches should at least have a minimum standard quality. Unlike some other PPAs/AURs which provide heavily patched Wine versions, we will not accept hacks for very diff --git a/README.md b/README.md index 214fe392..02028f80 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -What is wine-compholio? +What is Wine-Compholio? ======================= The **Wine "Compholio" Edition** is a special patched version of Wine that @@ -13,7 +13,7 @@ which are not present in regular wine, and always report such issues to us Included bugfixes and improvements ---------------------------------- -Wine-compholio contains fixes for the following Wine bugs: +Wine-Compholio contains fixes for the following Wine bugs: * ATL IOCS data should not be stored in GWLP_USERDATA ([Wine Bug #21767](http://bugs.winehq.org/show_bug.cgi?id=21767 "JLC's Internet TV crashes on startup")) * Add Dynamic DST exceptions for Israel Standard Time ([Wine Bug #36374](http://bugs.winehq.org/show_bug.cgi?id=36374 "Israel timezone handled incorrectly")) @@ -54,17 +54,17 @@ Besides that the following additional changes are included: * XEMBED support for embedding Wine windows inside Linux applications -How to install wine-compholio +How to install Wine-Compholio ============================= -Ready-to-use packages for wine-compholio are available for a variety +Ready-to-use packages for Wine-Compholio are available for a variety of different Linux distributions directly for download. Just follow the instructions below to install it (and all required dependencies). After the installation, please take a look at the next section for instructions how to use it in order to run your desired application. **Important:** If you already have pipelight installed on your system, there -is a good chance that you already have wine-compholio. Take a look at the +is a good chance that you already have Wine-Compholio. Take a look at the next section on how to find out if this is the case. If your distribution is not listed below, feel free to add a feature request @@ -98,7 +98,7 @@ Afterwards you have to add the following lines to `/etc/pacman.conf`: Server = http://cdn.fds-team.de/stable/arch/$arch ``` -Now you can install wine-compholio directly using `pacman`: +Now you can install Wine-Compholio directly using `pacman`: ```bash sudo pacman -Sy wine-compholio ``` @@ -196,7 +196,7 @@ zypper install wine-compholio ------------------------------------------------------------------- **Warning:** In contrary to other distributions, its not possible to have both -a regular wine version and wine-compholio installed at the same time - using +a regular wine version and Wine-Compholio installed at the same time - using the instructions below will replace your regular version. Moreover it will be installed to `/usr/bin/wine` in contrary to `/opt/wine-compholio/bin/wine`. @@ -228,7 +228,7 @@ our version. To do that just run: /usr/bin/wine --patches ``` -When you're using wine-compholio this will show to a list of all patches +When you're using Wine-Compholio this will show to a list of all patches included, for an unpatched version this command will fail. @@ -260,30 +260,30 @@ sudo urpmi.update -a sudo urpmi wine-compholio ``` -Using wine-compholio +Using Wine-Compholio ==================== Since we don't want to duplicate a lot of information here, we recommend to take a look at the [official Wine FAQ](http://wiki.winehq.org/FAQ) for general information about how to use Wine. The following part will mainly -concentrate on the differences between wine and wine-compholio. +concentrate on the differences between wine and Wine-Compholio. -Running wine-compholio +Running Wine-Compholio ---------------------- -**Using multiple Wine versions:*** Unless you specify a special `WINEPREFIX` -environment variable, wine-compholio will use the same wineprefix `~/.wine` +**Using multiple Wine versions:** Unless you specify a special `WINEPREFIX` +environment variable, Wine-Compholio will use the same wineprefix `~/.wine` (in your home directory) like regular wine. This allows you to use your already installed programs directly, without much effort or reinstalling -them. Often you have both regular wine and wine-compholio installed at the +them. Often you have both regular wine and Wine-Compholio installed at the same time, which is *absolutely no problem* - by typing in either `wine` (=regular wine) or `/opt/wine-compholio/bin/wine` you can decide, which wine version you want to run. You can switch between versions as often as you like - just make sure that all Windows programs have terminated before starting them with a different version. -To run wine-compholio always type `/opt/wine-compholio/bin/wine`, for example: +To run Wine-Compholio always type `/opt/wine-compholio/bin/wine`, for example: ```bash cd ~/.wine/drive_c// /opt/wine-compholio/bin/wine game.exe @@ -307,7 +307,7 @@ related programs, here are some additional example: ... ``` -If you're an experienced user, and always want to use wine-compholio, you +If you're an experienced user, and always want to use Wine-Compholio, you can also add `/opt/wine-compholio/bin` to your bash profile. We will not go into detail here, because such a setup has the big disadvantage, that it hides which version you're using - which is very important for getting @@ -325,11 +325,11 @@ regular wine. We're only a very small developer team, and although we would like to do that, we probably cannot really solve all your Wine bugs. When it turns out that the official Wine version also doesn't work, you can file a bugreport at the official [Wine bugtracker](http://bugs.winehq.org/). -Feel free to mention that you also tested with wine-compholio, but all +Feel free to mention that you also tested with Wine-Compholio, but all bugreport related information (logs, crashdumps, ...) should concentrate only on upstream wine. -If it turns out, that it works with upstream wine, but not with wine-compholio, +If it turns out, that it works with upstream wine, but not with Wine-Compholio, then it might be a regression caused by our patches. We would like you to report this issue to us, so we can fix it in future versions. You can also report issues, when testing with upstream Wine is impossible or it crashes @@ -356,7 +356,7 @@ increase chances to provide support and to fix it. * Did you install any overrides? (for examples by using `winetricks`) * Did you change any settings by running `winecfg`? -4. **Information about your wine-compholio version** +4. **Information about your Wine-Compholio version** * *Recommended:* Test with regular wine, and report if this works * Version number (`/opt/wine-compholio/bin/wine --version`) * Patches in your build (`/opt/wine-compholio/bin/wine --patches`) diff --git a/debian/tools/DEVELOPER.md.in b/debian/tools/DEVELOPER.md.in index 2c10a5cb..851e8fad 100644 --- a/debian/tools/DEVELOPER.md.in +++ b/debian/tools/DEVELOPER.md.in @@ -2,16 +2,16 @@ Developers and maintainers guide ================================ This document will provide some information targeted at developers, who -either want to build/package wine-compholio for their distribution, but also -for developers who would like to contribute their patches to wine-compholio, +either want to build/package Wine-Compholio for their distribution, but also +for developers who would like to contribute their patches to Wine-Compholio, to get them included in future releases. -Compiling wine-compholio +Compiling Wine-Compholio ======================== -**Warning:** Please note that starting with wine-compholio 1.7.23 it is +**Warning:** Please note that starting with Wine-Compholio 1.7.23 it is deprecated to manually apply patches without using the Makefile. To avoid typical pitfalls for package maintainers (like trying to use the patch commandline utility for binary patches or not updating the patchlist) it is @@ -26,7 +26,7 @@ Instructions The following instructions (based on the [Gentoo Wiki](https://wiki.gentoo.org/wiki/Netflix/Pipelight#Compiling_manually)) -will give a short overview how to compile wine-compholio, but of course not +will give a short overview how to compile Wine-Compholio, but of course not explain all details. Make sure to install all required Wine dependencies before proceeding. @@ -49,7 +49,7 @@ make -C ./patches DESTDIR=$(pwd) install ``` Afterwards run configure (you can also specify a prefix if you don't want to install -wine-compholio system-wide): +Wine-Compholio system-wide): ```bash ./configure --with-xattr ``` @@ -93,11 +93,11 @@ make -C ./patches DESTDIR=$(pwd) PATCHLIST="DIRNAME1.ok DIRNAME2.ok" install ``` -Contributing to wine-compholio +Contributing to Wine-Compholio ============================== -Please note that wine-compholio is not just an arbitrary collection of Wine -patches. We see wine-compholio as a **testing version** in preparation for +Please note that Wine-Compholio is not just an arbitrary collection of Wine +patches. We see Wine-Compholio as a **testing version** in preparation for patches to be submitted to upstream Wine. This implies that all patches should at least have a minimum standard quality. Unlike some other PPAs/AURs which provide heavily patched Wine versions, we will not accept hacks for very diff --git a/debian/tools/README.md.in b/debian/tools/README.md.in index 44a753d1..d7bf8c63 100644 --- a/debian/tools/README.md.in +++ b/debian/tools/README.md.in @@ -1,4 +1,4 @@ -What is wine-compholio? +What is Wine-Compholio? ======================= The **Wine "Compholio" Edition** is a special patched version of Wine that @@ -13,7 +13,7 @@ which are not present in regular wine, and always report such issues to us Included bugfixes and improvements ---------------------------------- -Wine-compholio contains fixes for the following Wine bugs: +Wine-Compholio contains fixes for the following Wine bugs: {bugs} @@ -22,17 +22,17 @@ Besides that the following additional changes are included: {fixes} -How to install wine-compholio +How to install Wine-Compholio ============================= -Ready-to-use packages for wine-compholio are available for a variety +Ready-to-use packages for Wine-Compholio are available for a variety of different Linux distributions directly for download. Just follow the instructions below to install it (and all required dependencies). After the installation, please take a look at the next section for instructions how to use it in order to run your desired application. **Important:** If you already have pipelight installed on your system, there -is a good chance that you already have wine-compholio. Take a look at the +is a good chance that you already have Wine-Compholio. Take a look at the next section on how to find out if this is the case. If your distribution is not listed below, feel free to add a feature request @@ -66,7 +66,7 @@ Afterwards you have to add the following lines to `/etc/pacman.conf`: Server = http://cdn.fds-team.de/stable/arch/$arch ``` -Now you can install wine-compholio directly using `pacman`: +Now you can install Wine-Compholio directly using `pacman`: ```bash sudo pacman -Sy wine-compholio ``` @@ -164,7 +164,7 @@ zypper install wine-compholio ------------------------------------------------------------------- **Warning:** In contrary to other distributions, its not possible to have both -a regular wine version and wine-compholio installed at the same time - using +a regular wine version and Wine-Compholio installed at the same time - using the instructions below will replace your regular version. Moreover it will be installed to `/usr/bin/wine` in contrary to `/opt/wine-compholio/bin/wine`. @@ -196,7 +196,7 @@ our version. To do that just run: /usr/bin/wine --patches ``` -When you're using wine-compholio this will show to a list of all patches +When you're using Wine-Compholio this will show to a list of all patches included, for an unpatched version this command will fail. @@ -228,30 +228,30 @@ sudo urpmi.update -a sudo urpmi wine-compholio ``` -Using wine-compholio +Using Wine-Compholio ==================== Since we don't want to duplicate a lot of information here, we recommend to take a look at the [official Wine FAQ](http://wiki.winehq.org/FAQ) for general information about how to use Wine. The following part will mainly -concentrate on the differences between wine and wine-compholio. +concentrate on the differences between wine and Wine-Compholio. -Running wine-compholio +Running Wine-Compholio ---------------------- -**Using multiple Wine versions:*** Unless you specify a special `WINEPREFIX` -environment variable, wine-compholio will use the same wineprefix `~/.wine` +**Using multiple Wine versions:** Unless you specify a special `WINEPREFIX` +environment variable, Wine-Compholio will use the same wineprefix `~/.wine` (in your home directory) like regular wine. This allows you to use your already installed programs directly, without much effort or reinstalling -them. Often you have both regular wine and wine-compholio installed at the +them. Often you have both regular wine and Wine-Compholio installed at the same time, which is *absolutely no problem* - by typing in either `wine` (=regular wine) or `/opt/wine-compholio/bin/wine` you can decide, which wine version you want to run. You can switch between versions as often as you like - just make sure that all Windows programs have terminated before starting them with a different version. -To run wine-compholio always type `/opt/wine-compholio/bin/wine`, for example: +To run Wine-Compholio always type `/opt/wine-compholio/bin/wine`, for example: ```bash cd ~/.wine/drive_c// /opt/wine-compholio/bin/wine game.exe @@ -275,7 +275,7 @@ related programs, here are some additional example: ... ``` -If you're an experienced user, and always want to use wine-compholio, you +If you're an experienced user, and always want to use Wine-Compholio, you can also add `/opt/wine-compholio/bin` to your bash profile. We will not go into detail here, because such a setup has the big disadvantage, that it hides which version you're using - which is very important for getting @@ -293,11 +293,11 @@ regular wine. We're only a very small developer team, and although we would like to do that, we probably cannot really solve all your Wine bugs. When it turns out that the official Wine version also doesn't work, you can file a bugreport at the official [Wine bugtracker](http://bugs.winehq.org/). -Feel free to mention that you also tested with wine-compholio, but all +Feel free to mention that you also tested with Wine-Compholio, but all bugreport related information (logs, crashdumps, ...) should concentrate only on upstream wine. -If it turns out, that it works with upstream wine, but not with wine-compholio, +If it turns out, that it works with upstream wine, but not with Wine-Compholio, then it might be a regression caused by our patches. We would like you to report this issue to us, so we can fix it in future versions. You can also report issues, when testing with upstream Wine is impossible or it crashes @@ -324,7 +324,7 @@ increase chances to provide support and to fix it. * Did you install any overrides? (for examples by using `winetricks`) * Did you change any settings by running `winecfg`? -4. **Information about your wine-compholio version** +4. **Information about your Wine-Compholio version** * *Recommended:* Test with regular wine, and report if this works * Version number (`/opt/wine-compholio/bin/wine --version`) * Patches in your build (`/opt/wine-compholio/bin/wine --patches`)