GitHub-Templates

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #go #machine-learning #deep-learning #macos #java #awesome #pytorch #security #ios #mcp

GitHub-Templates

(★ 60)

A collection of templates and documentation to help you manage your mod repos on GitHub.

파일 탐색기

최종 버전 다운로드 (.zip)

- - LICENSE.md
  - README.md
- - LICENSE-CC-BY-4.0.md
  - README.md
- - LICENSE-CC-BY-NC-4.0.md
  - README.md
- - LICENSE-CC-BY-NC-ND-4.0.md
  - README.md
- - LICENSE-CC-BY-NC-SA-4.0.md
  - README.md
- - LICENSE-CC-BY-ND-4.0.md
  - README.md
- - LICENSE-CC-BY-SA-4.0.md
  - README.md
- - LICENSE-CC0-1.0.md
  - README.md
- README.md
- MAINTENANCE-NOTICE.md
- README.md
LICENSE.md
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](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](Maintenance-Template/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](Maintenance-Template/MAINTENANCE-NOTICE.md) for this mod. This mod is additionally licensed under [CC-BY-4.0](https://creativecommons.org/licenses/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](Maintenance-Template/MAINTENANCE-NOTICE.md) 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](https://github.com/Gibberlings3/RealMod) readme.

### Latest Release:

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

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

### Downloads:

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

`![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](https://img.shields.io/static/v1?label=license&message=All%20Rights%20Reserved&color=red)

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

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

`![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](https://img.shields.io/static/v1?label=platform&message=windows%20%7C%20macos%20%7C%20linux&color=informational)

`![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](https://shields.io/) to find additional badges and resources to help you make your own custom badges.

GitHub-Templates

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

GitHub-Templates

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README