search

haaksmash / flowhub

Based on git-flow, but with GitHub.
22 stars 5 forks source link

Better start-up documentation #63

Closed isochronous closed 11 years ago

isochronous commented 11 years ago

The documentation regarding using FlowHub is excellent, but the documentation for setting up FlowHub is non-existant. Does it require Git Flow to be installed separately? Is there a different process for Windows vs Linux or OSX? Can it be integrated with any GitHub clients? The answers to these questions would help out new users tremendously.

haaksmash commented 11 years ago

Great suggestion! I'll add these to the main README, but just in case you need to know, I'll answer them here too:

Ideally the only setup you need to do is pip install or setup.py install, then flowhub init in your repo of choice.

Do you think that's enough set-up info for new users?

isochronous commented 11 years ago

I'd at least link to the pip install instructions. Once I did some googling and found out about pip, getting started wasn't too difficult, but better to link directly to it so people don't have to use google-fu to find it.

On Thu, Jan 24, 2013 at 3:12 PM, Haak Saxberg notifications@github.comwrote:

Great suggestion! I'll add these to the main README, but just in case you need to know, I'll answer them here too:

  • Flowhub does not require git-flow to be installed. Git-flow was only an inspiration, never a dependency.
  • Both OSX and Linux should be able to pip install (if you're into pip) or clone and setup.py install (if you're into dev) Flowhub without trouble. I've not tried to do anything with it on Windows, so I'm not sure if there are undiscovered issues there. Once installed, usage should be the same across all three.
  • I can't imagine that Flowhub currently integrates with any GitHub clients. If it does, that's a happy accident; Flowhub is only intended as a command-line tool.

Ideally the only setup you need to do is pip install or setup.py install, then flowhub init in your repo of choice.

Do you think that's enough set-up info for new users?

— Reply to this email directly or view it on GitHubhttps://github.com/haaksmash/flowhub/issues/63#issuecomment-12670762.