Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • Information and Tutorials Information and Tutorials
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Issues 9
    • Issues 9
    • List
    • Boards
    • Service Desk
    • Milestones
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Infrastructure Registry
  • Wiki
    • Wiki
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • Deterrence Dispensed
  • Information and TutorialsInformation and Tutorials
  • Wiki
  • For developers
  • Resources
  • Remixes
  • README.md Sample

Last edited by Vinh Nguyen Jun 25, 2021
Page history

README.md Sample

Here's a sample README.md for your use specifically in your remix folder

It creates a file that looks like this:

Remixes for MyProductName

A description of the product goes here.

Author License Description
sir_meowsalot GPLv2 A remix containing more meows
slurpking2000 MIT More boba pearls
soosh_lover_100 NLS More cheeto sushi

NOTE "NLS" is used for "No License Selected" in this document.

Create a README.md in the Remixes folder of your repository with the following contents:

# Remixes for MyProductName
A description of the product goes here.


| Author | License | Description|
| ------ | ------ | ------ |
| sir_meowsalot | GPLv2 | A remix containing more meows |
| slurpking2000 | MIT | More boba pearls |
| soosh_lover_100 | NLS | More cheeto sushi |

> **NOTE** "NLS" is used for "No License Selected" in this document.
Clone repository
  • For Developers
    • FAQ
    • FAQ
      • Types of Designs
    • Guides
      • Checklist to Deactivate an Admin
      • How to create a static webpage with GitLab Pages
      • How to set up a beta
      • How to use set up SourceTree
    • Process Management
      • Product Development Lifecycle
    • Resources
      • Release Package Requirements
      • Release Package Requirements
        • Assembly PDF Sample
        • README.md Sample
      • Remixes
        • README.md Sample
  • For Signal Boosters
    • Branding Guide
    • Graphic Assets and Guidelines
  • For Users
    • Acromania and Glossary
    • Active Beta List
View All Pages