Live data from Hacker News

Readme.so – Easiest Way to Create a Readme

readme.so

61–69 of 69 posts

Re: Readme.so – Easiest Way to Create a Readme

#61
post #39
post #23

Earlier quoted context omitted.

It is not about opening a text editor. It's about what you would type into that editor. The value provided is in the templates, not in the editor.

If someone is writing readmes all the time, why wouldn't that person have a pandadoc or similar template for this task?

Lol not sure if this is a joke or not. Who writes readmes all the time? And where does the project state that it targets these people ?

Re: Readme.so – Easiest Way to Create a Readme

#62

Nice! - It should also be able to generate a pdf on demand - It should have support for asciidoc (generate output in it)

Nice!

- You should realize that requesting random features to a 1-person FOSS project in a derogatory way is not cool - You should offer to pay or help out if you want features - You should consider working on communicating more nicely is an important skill

Re: Readme.so – Easiest Way to Create a Readme

#63
post #61
post #39

Earlier quoted context omitted.

If someone is writing readmes all the time, why wouldn't that person have a pandadoc or similar template for this task?

Lol not sure if this is a joke or not. Who writes readmes all the time? And where does the project state that it targets these people ?

I think that meant to be a joke.

I actually do create a few README files every month (cos of Microservices), but I still don't understand why someone would use a tool to generate README files.

Re: Readme.so – Easiest Way to Create a Readme

#64
post #62

Nice! - It should also be able to generate a pdf on demand - It should have support for asciidoc (generate output in it)

Nice! - You should realize that requesting random features to a 1-person FOSS project in a derogatory way is not cool - You should offer to pay or help out if you want features - You should consider working on communicating more nicely is an important skill

"derogatory" - really? can you point out how?

How would you phrase a feature request?

Re: Readme.so – Easiest Way to Create a Readme

#66
post #39
post #23

Earlier quoted context omitted.

It is not about opening a text editor. It's about what you would type into that editor. The value provided is in the templates, not in the editor.

If someone is writing readmes all the time, why wouldn't that person have a pandadoc or similar template for this task?

I wrote a README.md template because I started a bunch of projects of my own in the last month but I haven't used it so far and it is not more than a bunch of headers plus a license boilerplate.

Re: Readme.so – Easiest Way to Create a Readme

#67

Hey this is a pretty cool project. Nice job. One of my struggles at work has been inheriting some code base from whichever team that has no documentation or it’s not even clear why something was built in the first place. Sometimes we’re left scratching our heads — “how do I even build this thing?” I’m a strong believer in a concise Readme file.

Knowledge management is often forgot. When starting a new project I like to put some effort on summary, (planned) features, (expected) usage/API and license before I begin coding.

Re: Readme.so – Easiest Way to Create a Readme

#68
post #47

A VSCode extension (triggered on README.* files) that does this would be very nice to have

I went ahead and created vscode-readme it takes the templates used on readme.so and creates a snippet per section and if you use the readme snippet it combines all the sections https://github.com/ThreeCommaIO/vscode-readme . I just published to the extensions marketplace too.

Excellent! One of my favorite HN moments :)
Post reply on HN