Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upBuild-in tutorial or a more information in the readme #526
Comments
|
I was just thinking this haha. I'm currently leaning towards a wiki for in-depth documentation, and maybe I can whip up a couple more tutorial videos running through certain features. Last year I started working on a lazygit website: https://lazyg.it/ but I ended up losing motivation and ended up making lazydocker instead haha. But I think in general a wiki would be a good way to go |
|
Ow totally forgot about the lazygit website, didn't know you added some tutorial there. I also think that the build-in github wiki is a better way to go, everyone can edit that if you allow them to and it's much easier to find. |
|
indeed it does, hence why I haven't made any effort to advertise it haha |
|
I've just gone and made a page for the feature I just released: https://github.com/jesseduffield/lazygit/wiki/Directly-Changing-Code-Stored-In-Commits For some reason it's not letting me paste screenshots in. Any idea why that might be the case? It could actually be my slow internet but I wonder if github doesn't allow screenshots on wikis? However I just tested it on the readme and it didn't work there either. |
|
I think github only allows image uploading in issues and PRs. i think adding the gifs to the wiki would complete it and make it a nice manual. |
Is your feature request related to a problem? Please describe.
Ya this is a bit awkward to say but i don't know every feather in lazygit even though i probably have seen every line of code :).
And that's also my problem, i really like this tool but i i'm not a git power user though i know what is possible and i also know that lazygit makes a lot of things much easier but i just don't know how to get started because it's also possible to break things when working with more advanced git feathers.
Describe the solution you'd like
More information in the readme or wiki or have some kind of builtin tutorial.
Describe alternatives you've considered
Just trying git commands without knowing what exactly happens.
Additional context
I don't really need a git tutorial but a nice tutorial that shows the keybindings and what the effect is would be really nice.