Add README section about executable installation using Chocolatey

[tadeu]

I've created a project (clcache-builder) to build an executable version of clcache.py and to package it as a Chocolatey package, in order to make it easier to use clcache on environments without Python or with Python 2.

Please, feel free to review that project too. If you are interested in adding the package building to this repository, I could give some help,

[tadeu]

cc @nicoddemus

[nicoddemus]

This link formatting is wrong, I think it should be:

The package is automatically generated using AppVeyor by [ESSS/clcache-builder](https://github.com/ESSS/clcache-builder).

[nicoddemus]

Oops sorry, disregard my comment, I thought this was Markdown. 😝

[codecov-io]

Codecov Report

Merging #266 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #266   +/-   ##
=======================================
  Coverage   89.42%   89.42%           
=======================================
  Files           1        1           
  Lines        1040     1040           
  Branches      166      166           
=======================================
  Hits          930      930           
  Misses         82       82           
  Partials       28       28

Flag	Coverage Δ
#integrationtests	81.63% <ø> (ø)	⬆️
#unittests	55% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1e7b28a...dd4eb60. Read the comment docs.

[frerich]

Cool stuff! I'll give it a try -- as for package building: any help with that would be much appreciated. I've planned to provide packages of clcache (e.g. ZIP files with the binaries produced by PyInstaller) for a long time but never got around to learning how to do that. I just saw that AppVeyor (which we use for CI) supports 'deploying' data and GitHub supports hosting binaries for releases. A Chocolatey package might be a nice addition (or a start)! :-)

[tadeu]

@frerich You could try merging the steps of https://github.com/ESSS/clcache-builder/blob/master/appveyor.yml into your appveyor.yml, and make a nuspec file based on the version there. After setting these things up, it's pretty straightforward, it comes down to pip install pyinstaller, pyinstaller clcache.py and choco pack, the other stuff is version and artifact management.

[tadeu]

Chocolatey have a very nice feature that allows only clcache.exe to stay in the PATH, the other .dll and .pyd stay in a directory that is not in the PATH, so won't cause problems with executables that depend on libraries with the same name.

[frerich]

@tadeu Thanks a lot for your awesome work on packaging clcache! This has always been a bit of a blind spot for me - I hope you don't mind me taking your set of packages to define a first clcache release in the GitHub sense. :-)

As for this pull request: I'm considering to not extending the README file even further (it's fairly long already) but rather making more use of the Wiki. There are already a few initial pages and I think it might be good to have an 'Installation' page which then references an 'Installation via Chocolatey' page. The benefit of this is that I could reference it nicely from other places. What do you think?

[tadeu]

@frerich Thanks :)

I agree, you may drop these modifications here, since some of them don't make sense anymore (the build is already being done in this repo), and using the Wiki seems good. It would be nice to have a link in the README pointing to the Wiki, and perhaps other sections could be moved too.

[frerich]

Closing this ticket - I recently revamped the Wiki and added the instructions for how to use Chocolatey there.