Inspiration

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!

What it does

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

How we built it

Challenges we ran into

We struggled with implementation approaches for our tree generation algorithm. As a team, we experimented with taking advantage of data structures like tries. In the end, we learned a ton about fancy tree-like data structures that they hadn't heard of before!

Adding relative linking to code-blocks in the Markdown

Designing an appropriate TreeCore architecture

Accomplishments that we're proud of

Able to leverage the type check built into TypeScript to catch a whole class of bugs

What we learned

What's next for Tree-o-Tron

Implement comments for common file types like .gitignore, .eslintrc .prettierignore .prettierrc, etc. Implementation of Tree Core

  • Alignment
  • Deletions
  • Custom File Icons

Built With

Share this project:

Updates