search

MLH-Fellowship / 0.2.1-readme-dirs

A web application that generates helpful project structures for public GitHub repositories
https://project-structure-readme.netlify.app/
MIT License
1 stars 1 forks source link
css github-api html javascript react styled-components typescript

readme

Automatic Project Structures for README's

Description

A web application that helps automate README creation

Architecture

Read: https://github.com/MLH-Fellowship/0.2.1-readme-dirs/wiki/Tree-Core-Architecure

How it Works

Head to URL and type in your Github Project URL and watch a MarkDown Accessible README with pre-filled descriptions appear! With a one-click Copy/Paste you can update your README with the best MarkDown Project Structure README's you've ever seen! Example Github Project URL: https://github.com/MLH-Fellowship/0.2.1-readme-dirs

Project demo

WHY

We built this tool two solve two major issues and two minor issues:

Major Issues

1) README's don't contain project structures which make it difficult for contributors to understand where everything is and how what's happening inside the repository. 2) Existing Project Structures don't have hyperlinks making the UX of a project structure a bit difficult to navigate with excessive scrolling or third party plugins to extend the functionality. This requires no third-party software and can be done right in Github natively!

Minor Issues

1) You can plug in any repo you want to contribute to and completely understand what every folder does thanks to auto generated documentation! 2) You can attach Badges to your repository to help people find the correct NPM Package your repository references!

Technologies