DEV Community

Cover image for Don't create README files without this tool
Francisco Mendes
Francisco Mendes

Posted on

Don't create README files without this tool

I think everyone has already saved some markdown cheatsheet so I could create a README file faster.

However, sometimes it was better to have an editor to make the process of creating a ReadMe easier, more intuitive and more visual.

For that, I will talk a little about readme.so.

tool

Of course markdown isn't that complicated, but with all the things we have to learn, we always end up forgetting some syntax stuff.

And for a lot of people who want to optimize the process of creating their markdown files, I think this is a great tool for that.

And even for many people who do the documentation of their projects through markdown files, having a visual tool like this helps with consistency.

tooling

All sections that are on the platform have the most popular structures that is usually added in a README. Examples include features, Api references, information about deployment, contribution, among others.

And of course, in addition to adding them, we can also customize each one of them. And as we make changes, we can visualize them in real time.

final

As you can see in the image above, the way it is rendered in the preview is similar to the way the README is presented to us on Github.

And you can download the README file through the platform by clicking a simple button. It's fast, it's simple, and it works incredibly well.

What about you?

Have you tried readme.so?

Top comments (2)

Collapse
 
arvindpdmn profile image
Arvind Padmanabhan • Edited

Not the greatest tool. Users should be able to create templates. Also, it would be nice to drag and drop items in Sections to quickly reorder the sections.
BTW, an extension VS Code allows us to have live previews of markdown files.

Collapse
 
franciscomendes10866 profile image
Francisco Mendes

Good points! They were great additions. The project is still new but I believe that over time they will add it all up.