Git Product home page Git Product logo

the-good-documentation's Introduction

If you are interested in why I decided to organize this template in this way, maybe this article (that I wrote in Spanish) will be useful for you.

https://ivansantosgonzalez.dev/the-desired-documentation.

build tests version

Project Title

Introduction 🎉

A brief introduction about the project and its purpose.

Getting Started 🚀

Basic instructions to run and use the project, here we can link the contributing section where it is explained in depth.

Pre-requisites ✔️

List of software or other things needed to launch the project and instructions about how to download and install them.

Installation 🛠

Step by step guide about how to install the project. It is something like a tutorial about the software installation (it could include images, code snippets or screenshots if it is neccessary).

Running the project ✈️

Step by step guide about how to run the project. It is something like a tutorial about the project running (it could include images, code snippets or screenshots if it is neccessary).

To know more about project installation and running see Getting Started section of contributing document.

Contributing 🖊️

Explanation about how to contribute or work on this project. You can link to a document CONTRIBUTING.md

If you want to contribute to this project, we invite you to read the CONTRIBUTING.md document.

Versioning 🧾

Explanation of the versioning standard we use and link to CHANGELOG.md.

We use SemVer for versioning. In CHANGELOG.md you will be able to see the different versions as well as their changelogs.

License 📝

Short explanation about the project license and link to the License file.

This project is licensed under the license terms of GNU GENERAL PUBLIC LICENSE Version 3 and the license file can be found in LICENSE document.


Made with ❤️and ☕ by Iván Santos

the-good-documentation's People

Contributors

ivansantosgonz avatar

Stargazers

Daniel Ramos avatar Juan Antonio avatar Brandon Valle avatar Ari avatar Fran avatar Pablo Pérez González avatar Ruben Zagon avatar José Ángel Nieda avatar Ulises Santana avatar Cristian Suarez avatar Eric Driussi avatar Alexandra Rivero avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.