search

jubobs / gitdags

A package for drawing educational Git history graphs
218 stars 29 forks source link

Add "getting started" documentation to the Readme. #1

Open shaunluttin opened 10 years ago

maphy-psd commented 9 years ago

Here is a little minimal working example http://stackoverflow.com/questions/1057564/pretty-git-branch-graphs/25468472#25468472

jubobs commented 9 years ago

For what it's worth, I hope to produce proper documentation for the package within the next few weeks, with more examples of what can be done with it. Be patient :)

ChrisFreeman commented 9 years ago

@Jubobs: Thank you for your work on gitdags. I would VERY much like to use gitdags for generating documentation. I highly encourage you to keep making progress on the documentation!!

I haven't used LaTeX since the '80s. I am tried to get gitdags working on Ubuntu 14.04. After many attempts (involving apt-get, tlmgr, moving .STY files around, etc), I've had no luck. I've scoured StackOverflow, but couldn't find a sufficient start-to-finish example. I think my issue involves getting the correct packages installed in the correct place using the correct pkg manager. Even the "minimal working example" above, and the wiki didn't giving me enough clues.

ChrisFreeman commented 9 years ago

@Jubobs: I got it to work on Ubuntu 14.04. The write up is here: http://chrisfreeman.github.io/gitdags_install.html

jubobs commented 9 years ago

@ChrisFreeman I've only just seen your comments. Thanks for that.

I'm partly to blame for why getting this to work is complicated; once I successfully submit gitdags and xcolor-solarized to CTAN, they will become part of your TeX distribution and you won't need to install them "manually".

Documentation for gitdags (incl. a bunch of examples) is on its way. In the meantime, if you can't figure out how to produce a particular diagram, I encourage you to open a new issue here or on the TeX Stack Exchange site.

cynipe commented 9 years ago

[FYI] I just created docker image for gitdags. https://registry.hub.docker.com/u/cynipe/gitdags/

Thank you for providing such a nice tool!!

hpurmann commented 9 years ago

I put some installation instructions for Mac on my blog. The explanations of @ChrisFreeman were of great help, thanks for that :+1:

mindthump commented 8 years ago

Thanks for gitdags! I'm not at all a TeX user, but I played with it many, many years ago so it wan't completely foreign to me. I got it working fairly easily on Windows 7 using TeXworks. The only thing I needed to do was create a local texmf folder (??), clone your repo there, and add the texmf to MikTex's roots.