KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #dsh #dsh-plugin #ai-agent #claude-code #codex #typescript #ai-agents #mcp #cli #rust #deepseek-harness

readme-creator

★ 11 Open GitHub ↗

Site to create outstanding README files for github profile or projects in a easy way

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
	📜 Readme Creator
</h1>

<h3 align="center">
	🚀 Create READMEs for GitHub profiles or projects in an easy way
</h3>

<h4 align="center">
	Status:  Available to run locally
</h4>

<p align="center">
	<a href="#about">About</a> •
	<a href="#features">Features</a> •
	<a href="#tech-stack">Tech Stack</a> •
	<a href="#installation">Installation</a> •
	<a href="#usage">Usage</a> • 
	<a href="#contact">Contact</a> 
</p>

<br/>

> 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?** <br> _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)._

</span>
<br/>

## Features

- [x] Profile README
- [x] Project README
- [ ] Download file directly from the site

<br/>

## Tech Stack

- Frontend: </br></br>
  <img src="https://img.shields.io/badge/Html5-05122A?style=flat&logo=html5" alt="html5 Badge" height="25">&nbsp;
  <img src="https://img.shields.io/badge/Css3-05122A?style=flat&logo=css3" alt="css3 Badge" height="25">&nbsp;
  <img src="https://img.shields.io/badge/Javascript-05122A?style=flat&logo=javascript" alt="javascript Badge" height="25">&nbsp;
  <img src="https://img.shields.io/badge/Bootstrap-05122A?style=flat&logo=bootstrap" alt="bootstrap Badge" height="25">&nbsp;

- Backend: </br></br>
  <img src="https://img.shields.io/badge/Python-05122A?style=flat&logo=python" alt="python Badge" height="25">&nbsp;
  <img src="https://img.shields.io/badge/Flask-05122A?style=flat&logo=flask" alt="flask Badge" height="25">&nbsp;

<br/>

## Installation

> README creator is currently available on the [**internet**](https://readmecreator.herokuapp.com/), 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](https://git-scm.com/)
- [Python](https://www.python.org/)

To install README Creator, follow these steps:

```sh
# 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
```

<br/>

## Usage

To use Readme Creator, run the python file:

```sh
# Running
python application.py
```

Go to [http://127.0.0.1:5000/](http://127.0.0.1:5000/) to see the app running.

<br/>

## Contact

Made with ❤️ by [Tiago Barros](https://github.com/tiagobpires), get in touch!

<a href="mailto:tiagobarrospires@gmail.com" target="_blank"><img src="https://img.shields.io/badge/tiagobarrospires@gmail.com-D14836?style=flat&logo=gmail&logoColor=white" alt="Email Badge" height="25"></a>&nbsp;
<a href="https://www.linkedin.com/in/tiagobpires" target="_blank"><img src="https://img.shields.io/badge/tiagobpries-0077B5?style=flat&logo=linkedin&logoColor=white" alt="LinkedIn Badge" height="25"></a>&nbsp;

readme-creator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README