search

juan-leon / lowcharts

Tool to draw low-resolution graphs in terminal
MIT License
198 stars 5 forks source link

Add the README file to the binary archives in releases #51

Open m040601 opened 11 months ago

m040601 commented 11 months ago

First of all thank you for this tool. I just love it.

I am exploring and testing lotz of plotting in the terminal little tools and this one is really nice and performant.

I'm using the https://aur.archlinux.org/packages/lowcharts-bin package.

Very nice that you have remembered to include extensive help for all the subcommands with the --help flag.

One thing I'm missing is more examples. The ones you have are on the README and are all related to PC stuff.

Maybe in the future if you have lotz of them you could even have them in an extra Examples.md ?

Like, some example test data with "echo" "printf" "seq" "awk" "paste" "shuf" "random etc. 

seq 5 | awk '{print 2*$1, $1*$1}'
seq 2.324 0.3 5.234  | shuf | paste - -

(Inspiration from https://www.gnu.org/software/datamash/manual/html_node/index.html and https://github.com/dkogan/feedgnuplot)

I am always forgetting the lowcharts examples and coming back to the Internet to read the README.

It would be nice to have it offline on my PC if you ship both those simple markdown files in the tar.gz released.

Just like, https://github.com/juan-leon/lowcharts/issues/4 asked for the license.

Thanks in advance.

juan-leon commented 11 months ago

Thanks for the suggestion.

I like the "Examples.md" thing, as the README has some github things (badges, refs to png pictures) not suitable for a local markdown file.

I need to think on some good examples and write them (then it is trivial to write that file into release files)