Skip to content

:octocat: The awesome ReadMe of your project in less than 2 minutes! It's really simple!

License

Notifications You must be signed in to change notification settings

lucas-felinto/readme_maker

Repository files navigation

logo


GitHub last commit
GitHub language count GitHub top language License
My Linkedin



About   |    Technologies   |    Requirements   |    How to Contribute   |    Getting Started   |    Collaborators   |    Licence

ℹ️ About

ReadME Maker is an application designed to help developers build the README.md of their projects. In order to facilitate the creation of the text, some questions are asked about the project, presenting at the end of the application all the markdown ready to be implemented in the README.md file of your project on GitHub.

🚀 Technologies

The project was developed using the following technologies:

🌱 Minimal Requirements

🔗 How To Contribute

Everyone is welcome to collaborate with the project! For this:

  • Fork the repository
  • Clone your forked repository
  • Create a branch
  • Commit your changes
  • Push
  • Create the PR

Keeping your fork up to date:

  • Clone your fork git clone https://github.com/seuusuario/readme_maker.git
  • Add a remote to your original repository git remote add nomedabranch
  • Update the remote git fetch nomedabranch
  • Do the rebase from master with your remote master git rebase nomedabranch/master

Your fork is update!

🔰 Getting Started

Cloning the repository:

  • $ git clone https://github.com/lucas-felinto/readme_maker.git

Download the dependences:

Go to the root of the project

  • npm install

Executing

In the development mode:

  • npm run dev

In the production mode:

  • npm run start

:octocat: Collaborators

Author

👤 Lucas Felinto

Collaborators


Wemerson Jesus

Maicon Boer

José Eduardo

Felipe Schiavon

Vinicius Kammradt

Robson Antonio

✏️ Licence

This project is under the MIT license. See the archive LICENSE for more details.

About

:octocat: The awesome ReadMe of your project in less than 2 minutes! It's really simple!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published