Generic Project 📄

A template that apply to all Github projects.

About

Behind every github repository there is an idea that should be shared but sometimes is not easy to explain it. This repository serves as a super generic template so you can explain your ideas.

It uses format ideas from several great github projects, like using badges to comunicate project status, the use of single line indexes, images, animations and emoticons!

Features

Some projects might have several resources (documents, images, code...) so it is important to present this in a simple list.

This template contains the following features:

• This readme file that serves as simple and padronized way of explain your projects.

• A LICENSE file example to explain others how they can use the project.

Usage

Every public project can be reused in different ways, so its nice to explain to the others. This project can be used in two ways: to create a new project and to create new templates.

Project

• Select the Use this template button that appears on the project menu or use this link.

• Give your new project a name, a short description and choose if it will be public or private. You can change all this later.

Template

• Follow the same steps for creating a new project

• Access the settings menu on the new project

• Check the option Template repository that appears below the repository name

Contribute

There are several ways of helping any project:

• Using the project

• Sharing with your friends

• Creating questions or alerting about some problem or bug trhough the issues function

• Making a fork and creating pull requests

Credits

All projects are a colletive work and its crucial to give credit to all contributors even the indirect ones.

Thanks to the following contributors:

• iconella organization icon

See also

Here are some related links that might be interestant:

• Make a README - Explains why is so important a good readme file

• Mastering Markdown - Explains how to use the Markdown language to format text, create headers and links

• Unicode Emoji List - The complete list of emojis that can be copied and pasted on your readme (😍 😎 👽 👻 🙈 👀)

• Shields IO - Creates badges to show meaningful information about the project 👉

License

This project is licensed Creative Commons Zero v1.0 Universal so you can use it anyway you want.

Using this template you are free tho change the license on your own project to any license you want.

Visit https://choosealicense.com/ and learn how to choose the right license to your project.