hledger-mode
hledger-mode copied to clipboard
narendraj9
Lacking documentation
Hi,
thank you for your package. I think the project lacks some documentation. For example:
- the animated GIF in the README looks great but the features it demonstrates are not described anywhere. Would it be possible to have a list of the commands used in the demo?
- I don't see any list of features that the package supports nor how to use any feature.
I totally agree. When I started working on this, I was building it mostly for myself. Some features are not used at all (not even by me). It's possible they do not work anymore. I will definitely add the commands that the demo uses to the Readme.md soon.
Hi @narendraj9. I use ledger-mode because of some useful features and it is a while since I tried hledger-mode. I see there were some commits last year. Are you looking for more contributors ? A useful addition to the readme could be a comparison with ledger-mode, reasons to use one or the other, and maybe more discussion of next steps if any ?
Also, FWIW the example emacs config is probably full of useful tips, but at first glance it scared me - could be worth also showing a minimal one for getting started ?
could be worth also showing a minimal one
Oops, it's already there - my bad!
Hi @narendraj9. I use ledger-mode because of some useful features and it is a while since I tried hledger-mode. I see there were some commits last year. Are you looking for more contributors ? A useful addition to the readme could be a comparison with ledger-mode, reasons to use one or the other, and maybe more discussion of next steps if any ?
Hey @simonmichael , I am not actively working on the project. If you would like to contribute or become a maintainer, that will be great :)
Thanks for the update @narendraj9. I use ledger-mode myself and don't have time to help much with this, but I'll put the word out.