SPEEDME: Professional README.md generator

#

Table of Contents

• Description
• Installation
• Usage
• Tests
• Contributing
• License
• Questions #

Project Summary

SPEEDME is the ultimate README.md generator. Load up the CLI program, ask a few questions and let it generate a professional looking readme in no time. Featuring both Lightweight and Professional modes, you can select the level of detail you want to have.

Motivation

To make an advanced auto generating readme. Using markdown and HTML, I wanted to make sure it was as good as my other readme files.

Challenges

Many. I made it too complicated initially before making MVP and had to back track quite a bit. I had grand visions of modularising my scripts, which was working well until I had too many other commitments so I had to stick with the original single script version. I asked 2 TA's about my pro version code and they said they couldn't fault it. I guess it's just one of those bugs. I still have the 'Professional' version in the pipeline, so will be updating this once the bug is fixed. Lessons learned!

Unique Selling Points

I think it's an attractive, enjoyable program that produces a great looking, very professional readme. The emoji's make it cuter and the actual content generated is pretty close to my current default readme's - the professional mode offers way more control over which headings you want and way more screenshots, UI design wireframe shots and more.

#

(back to top)

Installation

To install and use this CLI program you must first head to your terminal: type 'npm install' to download the latest version of NPM. Next, you'll need want to initialise npm: 'npm init -y' or without -y if you want to specify you're own settings. Next up is node.js. Install by typing 'npm install node' - you'll want to use version 19.1 on an M1 Macbook though; I ran into issues with 19.6. Finally install dependencies: npm i inquirer. Lastly you can run the program by going to the root folder and typing 'node index.js' - if you run into issues you'll need to check npm and check npm ls to make sure you have all the correct dependencies!

Usage

Create a pro readme in minutes - no need to worry about formatting, the auto capitalise function takes care of that - add all images including header, logo and screenshots to ..assets/images. Done! Here is a screenshot of the program running. The pro version will have multiple screenshots its a WIP.

Tests

If you want to test the app you could run the debugger via vscode - we havent covered official unit testing yet so I cannot really provide much info here.

Contributing

The project IS open source. Feel free to clone and re-use or improve it, but please do respect the rules of my license and accredit your readme with my name and github username/url.

(back to top)

SPEEDME that README generator is an Open Source Project:

Code of Conduct:

Learn more about open source code of conduct: Contributor Covenant

Read the full code of conduct here: English (HTML version)

Attribution

Contributor Covenant is included in this open source project. Read the license. ;

#

License

This project is licensed under the terms of the GNU AGPL v3.0 license.

For more information, please visit this link: GNU AGPL v3.0

#

Questions

For questions or concerns, please contact matt-jones-developer via Github.

Other contacts:

You can also reach me via the following: 👻💬

📪 Email · LinkedIn · Twitter · Slack · Instagram

(back to top)

#

Deployment & Repo links:

Project Repo Link: https://github.com/Matt-Jones-Developer/speedme_that_readme_generator/

Deployed Project Link: https://github.com/Matt-Jones-Developer/speedme_that_readme_generator/

The VIDEO LINK

See the app being fully tested here: Video Link

See the finished readme being demonstrated here: Video Link