FileMap

Open the Command Palette by pressing Ctrl+Shift+P (Windows, Linux) or Cmd+Shift+P (macOS).

Search for the "Generate README" command and select it.

About the extension

This extension is designed to help generate a README.md file for a project in Visual Studio Code. A README.md file is a common file found in software projects that provides information about the project, such as its purpose, how to use it, and any other relevant details.

With this extension, the user can select which directories to include in the README.md file and the extension will automatically generate a markdown file with a list of all the files and directories, along with any file descriptions that have been provided in the source code.

This extension was made using ChatGPT, a large language model trained by OpenAI.

How to use this extension

To use this extension, you can follow these steps:

Install the extension in VS Code by going to the Extensions view, searching for "generate readme", and clicking the Install button.

Once the extension is installed, open a project in VS Code.

Open the Command Palette by pressing Ctrl+Shift+P (Windows, Linux) or Cmd+Shift+P (macOS).

Search for the "Generate README" command and select it.

A UI panel will appear with checkboxes for each directory in your project. Select the directories that you want to include in the README file.

Once you have made your selections, click the "Generate README" button.

The README file will be generated in the root directory of your project.

Note that this extension only works with projects that have a valid directory structure. If your project does not have a valid directory structure, the generated README file may not be accurate.

Commands

Open the Command Palette by pressing Ctrl+Shift+P (Windows, Linux) or Cmd+Shift+P (macOS).

Search for the "Generate README" command and select it.

Comments

Write a comment in the file starting with "file description:" and this comment will show after the link in the README.md file

// file description: This file is about Home page

This README.md file was generated with the help of ChatGPT, an AI language model developed by OpenAI. It provides an overview of the contents of the project and can be a useful reference for developers working on the project.