📜 Readme Creator

🚀 Create READMEs for GitHub profiles or projects in an easy way

Status: Available to run locally

About • Features • Tech Stack • Installation • Usage • Contact

Unfortunately this project was deployed on Heroku, but the company no longer has a free plan! While we don't deploy at other plataform, you can run the project locally!

About

README creator is a hands-on website to quickly create great READMEs for GitHub profiles or projects.

You just need to fill in the form with the information you want to share based on the options, click on "Create README" and copy it to your repository!

And that's it, you have an outstanding readme 😁 🎉

✨ Did you know?
README is traditionally written in upper case. That's because command-line environments would then put the file at the top. This makes them easily visible, specially in big directories (upper-case letters come before lower-case letters in ASCII ordering).

Features

• Profile README
• Project README
• Download file directly from the site

Tech Stack

• Frontend:
  
         

• Backend:
  
     

Installation

README creator is currently available on the internet, but if you want to run it locally, follow the steps below:

Before you begin, you will need to have the following tools installed on your machine:

• Git
• Python

To install README Creator, follow these steps:

# Clone this repository
$ git clone https://github.com/tiagobpires/readme-creator.git

# Create a virtual environment (optional but recommended):
$ python -m venv venv

# Activating the virtual environment:
$ source venv/bin/activate

# Install requirements:
$ pip install -r requirements.txt

Usage

To use Readme Creator, run the python file:

# Running
python application.py

Go to http://127.0.0.1:5000/ to see the app running.

Contact

Made with ❤️ by Tiago Barros, get in touch!