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

Write logic to generate project structure #6

Closed nchaloult closed 4 years ago

nchaloult commented 4 years ago

If we use Github's API to traverse the project structure of a public repo, one of the things that we get back are absolute paths to each file in the repo as strings. Given a list of these file path strings, we need to generate Markdown with a "tree printout," similar to that of the tree command.

If we recognize the name and placement of a particular directory, we should include a comment about what that directory is for in this printout. For instance, if we find a src/ directory at the root of the repo, we should include a statement about how source files live there, as opposed to other types of files in the repo.

nchaloult commented 4 years ago

I've written a first draft of some functionality.

What Works

What Isn't Ready