Convert README to Markdown

ccontavalli / ssh-ident

Different agents and different keys for different projects, with ssh.

Other

965 stars 71 forks source link

Convert README to Markdown #17

Closed chrisfinazzo closed 3 years ago

chrisfinazzo commented 8 years ago

Is there a reason you chose "Software Package Notes"? My apologies in advance, I'm not well-versed with Python or Debian to know whether or not this is standard practice. If the idea is appealing, I will submit a PR for this and #16.

ccontavalli commented 8 years ago

Today, I generate the README by using the command "pydoc ./ssh-ident", this extracts the comments from the .py file, and generates the man page and README.

There was at least another issue raised a month or two ago mentioning that the documentation could be clearer and better formatted. So I'm all for it :) if you have time, that'd be great.

Sorry it took me a while to get back to you. Thanks!

kominoshja commented 3 years ago

Just came across this after submitting https://github.com/ccontavalli/ssh-ident/pull/64 :)

chrisfinazzo commented 3 years ago

@kominoshja This was on my list for a long time, I guess it just fell off the radar. Thanks for picking it up.