Giters

mikefourie-zz / MSBuildExtensionPack

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Missing instructions on how to use this...

balmyBanzai opened this issue · comments

commented

I don't even know where I'm supposed to start to use any of this. Please add that info or a link to that info in your README

commented

the home page links to http://www.msbuildextensionpack.com/ which has the help files. Is that not enough?

commented

@mikefourie would you mind adding the link http://www.msbuildextensionpack.com/ to the github project description? My entry point was the "ProjectUrl" from the nuget, which points to this github project. That's fine. However, from here I could not find any reference to the above mentioned website.

  • The github project descriptions states "No description, website, or topics provided."
  • The readme has a badge that links to a readthedocs page with no content
  • The readme has a paragraph that says "Each task is documented ..." but gives no hint on where to find this documentation
  • The repo contains a .chm file of 1.8 MB which displays on my Win10 machine only the index but no content

Eventually I found this very issue which points be to the homepage. There I finally found a working documentation and the useful link to your MSBuild Explorer (nice tool, btw! together with MSBuild Log Viewer a must-have for any msbuild related work).

My wish: Please make it easier to find the homepage, when comming from github. Just mention http://www.msbuildextensionpack.com/ in the project description and the readme. Done.