bitovi / documentjs

The sophisticated documentation engine
https://documentjs.com/
MIT License
598 stars 381 forks source link

Unable to install on Windows without git #214

Open rjgotten opened 9 years ago

rjgotten commented 9 years ago

npm ERR! git clone https://github.com/documentjs/node-github-download undefined

On Windows systems it is common to install either the GitHub for Windows client or to use Git support integrated with Visual Studio. Neither scenario exposes a global commandline git client as is the standard with *nix-like OSes.

The whole point of using a package manager like NPM is to actually install a package. Why does the package installation attempt to use Git to clone the HEAD revision of the unstable master branch? This is not how you build a versioned, production-ready package.

I can understand taking a dependency on a Git commandline client when actually documenting a release present in a git repository, but leveraging Git to install the actual documentation framework itself is asinine. It locks out Windows users from using your tooling even if they would not need to go out to a remote repository to fetch documentation sources.

justinbmeyer commented 9 years ago

There's no need to get upset over this. Just point it out and we will change it.

The only reason it points to a github project was to make windows work: https://github.com/bitovi/documentjs/commit/e625bcaf80ded8eb12b3bf87a5ea4218a50e7863#diff-b9cfc7f2cdf78a7f4b91a753d10865a2L33

I had to fork a dependency project, and make it work with windows. Pointing a a repo is easier for development. Once everything was working, I forgot to make my own release and point DocumentJS at it release.

Not a big deal.