Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 1.53 KB

README.md

File metadata and controls

62 lines (33 loc) · 1.53 KB

CLI-Based README Generator Rust

[License: MIT]

Description

This program is a cli-based readme generator that, following some cli prompts, will write a fully featured README.md file for your project.

Table of Contents

InstallationUsageCreditsLicenseFeaturesContributionsTest

Installation

If you are interested in cloning and running this application on your local machine, please ensure you have the Rust toolchain installed - this can be found at https://www.rust-lang.org/tools/install. Once the repo has been cloned, from the command line, navigate to the root of the project directory and enter $ cargo build. For further usage instructions, see link.

Usage

After following the Installation instructions, enter $ cargo run in the command line from the root of the project. The app will start in the cli.

Credits

brahm van houzen

License

(https://opensource.org/licenses/MIT)

Features

  • cli interface

  • table of contents

  • license badging and linking

    Technologies

    • rust
  • dialoguer

    Contributions

    Test

    Questions

    If you have any questions about the project you can reach out to me via email or GitHub with the information below.

    Email: brahmvanh@gmail.com

    GitHub: brahmvanh