GithubGuide is a command-line tool that can take in any GitHub repository as input and produce explanations of what each file and folder is for in the repository. The Chrome extension is built with JavaScript, and uses the GitHub API to fetch repository contents and metadata. Repositories are read into our chosen LLM ChatGPT using a reader built on LLaMa, which is a connector between LLMs and external data.
Follow this tutorial to install the RepoExplainer Chrome extension.
- After you've installed the extension, make sure it is enabled.
- Once enabled, all GitHub repositories you visit will automatically have an info icon that tells you more information about each file and folder. If you hover over the info icon, a pop-up box containing information about the corresponding file/folder will appear.
--- REPOSITORY FILE TREE ---
README.md : Project description
LICENSE : License information
requirements.txt : Required packages
setup.py : Installation script
io (folder) : Contains classes and auxiliary code for I/O operations
├─► json (folder) : Contains packages and code related to json I/O
├─► xml (folder) : Contains classes related to converting data to/from XML
└─► base.py : Abstract implementation of the generic I/O interface
Contributions are always welcome! If you'd like to contribute, please fork the repository and create a pull request with your changes. Before submitting your pull request, please ensure that your code includes tests for any new functionality.