How To Make A README and How To Use A README Generator

by Cecilia Abrahamsson, Audrey Bichelmeir, Clarisse Bonang, Miles Milosevich

About This Page

Welcome to "How to make a README and use a README Generator"! We will cover a two-part tutorial on making a README and utilizing the README Generator that we created. You will need experience with Github and an Integrated Development Environment (IDE) for this tutorial. The Youtube Professional README Generator tutorial provides visual instruction.

How to make a README steps:

  1. Open your repository in your choice of IDE, whether it be Visual Studios, Atom, or others.
  2. Navigate to the root directory of your current repository. In Visual Studios, this can be done through navigating through folders in the left hand side display; in Atom, this can be done through your file browser window.
  3. Create a new file. When prompted for a name for the file, enter "README.md"
  4. Now that we have the file created, it is time to begin the README. FIrst line should be of a format similar to:
    • That is, including a single hash (#) followed by the project name.
  5. Now, create a heading for Description, again starting with a single hash.
  6. Type ‘##’ to create a Table of Contents
    To link sections to the table of contents, follow the image below.
  7. Type ‘##’ prior to each section name.
    Ex: ## Installation
    • Installation:
      To install the necessary dependencies, type the commands in this section.
    • License:
      Refer to the License section.
    • Contributing:
      Notify the reader to contact you if they intend to contribute to the repository.
    • Tests:
      The test section provides commands to run different tests that can be executed. The user’s program may have coding examples that run with the main program. Provides instructions for grader/user pulling from repo.
    • Questions:
      Inform the reader that you are open to questions and discussion about your program.
  8. Licensing. Many options exist for choosing a license for your project, depending on how you want others to use your project. In order to insert a license into a project, simply create a new file containing one of the following license formats. When choosing a license, it is important to consider freedoms of distribution, sourcing & citations, and warranties and liabilities. These topics will be covered below.

    Link to Licensing section
  9. You have successfully provided a README and documentation for your code.

How use a README generator:

Description:

The following program prompts the user for information about the repository through the command-line. Then, the program generates a README with the following information: title of my project and sections entitled Description, table of contents, installation, usage, license, contributing, tests, and questions

Things you will need:

Steps:

  1. Go to Github gentorator repository
  2. Click Code. A dropdown menu will be displayed. To clone the repository, select HTTPS under “Clone”. Then click
  3. Open Git Bash/Terminal
  4. Go to the directory where you want the cloned repository to be located
  5. Type git clone "https://github.com/csbonang/bonang_README_Generator" or type git clone and paste the copied link from Step 2.
  6. Open your repository in your choice of IDE, whether it be Visual Studios, Atom, or others.
  7. Navigate to the root directory of your current repository. In Visual Studios, this can be done through navigating through folders in the left hand side display; in Atom, this can be done through your file browser window.
  8. To download/update dependencies, type the following command: npm i
  9. Run the following command to run the bonang_README_Generator program. node index.js
  10. The user will be prompted by a series of questions before the README is created. Here is an example of what the prompt looks like as well as what a user might input.
  11. Select USER_README.md. Then, click the Markdown Preview enhanced icon to view the created README or (Ctrl+K+V). The information inputted by the user in step 2 should be displayed.

Licensing