Code Monkey home page Code Monkey logo

github-templates's Introduction

GitHub Templates

Licenses

Including a LICENSE file in your mod is a good way to let others know what they can and can't do with your mod. Visit the License-Templates folder in this repository to find several common licenses and a guide to help you pick one.

Maintenance Policy

Regardless of which license you choose, you should also establish whether you accept bug fixes, compatibility fixes, and translation updates from the community. You can make this abundantly clear by including the file MAINTENANCE-NOTICE.md in the root directory of your repository.

Readme

In the Copyright section of your readme, you should include your copyright notice and list the maintenance policy and license you have chosen. When using one of the Creative Commons licenses, it's a good idea to link to the human-readable summary of the license on creativecommons.org.

Sample copyright section for a mod licensed under CC-BY-4.0:

Copyright

This mod is copyright (c) 2019 Author.

You are allowed to submit maintenance updates for this mod. This mod is additionally licensed under CC-BY-4.0.

Sample copyright section for a mod with no license and no permissions granted except for maintenance updates:

Copyright

This mod is copyright (c) 2019 Author.

Content from this mod may not be mirrored, borrowed, or altered without explicit permission. You are allowed to submit maintenance updates for this mod.

Badges

You can include badges at the top of the README file in your repo to quickly convey important information about your mod. You can see this in action on the RealMod readme.

Latest Release:

GitHub release (latest by date including pre-releases)

![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/gibberlings3/itemrevisions?include_prereleases)

Downloads:

GitHub All Releases

![GitHub All Releases](https://img.shields.io/github/downloads/gibberlings3/itemrevisions/total)

Custom - License:

You can create a custom badge and write in the name of the license you are using.

License

![License](https://img.shields.io/static/v1?label=license&message=All%20Rights%20Reserved&color=red)

License

![License](https://img.shields.io/static/v1?label=license&message=CC-BY-4.0&color=green)

Custom - Platform:

Custom badges can display whatever information you want. You might want to display which platforms your mod is compatible with.

Platform

![Platform](https://img.shields.io/static/v1?label=platform&message=windows%20%7C%20macos%20%7C%20linux&color=informational)

Other Badges:

You can visit shields.io to find additional badges and resources to help you make your own custom badges.

github-templates's People

Contributors

mike1072 avatar lynxlynxlynx 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.