Git Product home page Git Product logo

choosealicense.com's Introduction

Choose a License Web Site

Like a Choose Your Own Adventure site, but only much less interesting.

Intro

A lot of repositories on GitHub.com don't have a license. GitHub could slap on a license chooser, but if you don't know anything about licenses, how are you supposed to make an informed decision.

ChooseALicense.com is designed to help people make an informed decision about licenses.

Immediate Goals

  • Politics Free - Let's just not get into it.
  • Well designed, but that goes without saying.
  • The homepage should have just enough to help 99% of folks make a decision.
  • For the 1%, the site will contain a list of licenses common for specific communities and situations.
  • Not comprehensive. Seems like an odd goal, but there are a bajillion (I counted) licenses out there. We're going to have to filter that down to a small list of those that matter.

Run It On Your Machine

  1. git clone https://github.com/github/choosealicense.com
  2. cd choosealicense.com
  3. script/bootstrap
  4. script/server
  5. Open localhost:4000 in your favorite browser

Adding a license

Licenses sit in the /licenses folder as markdown (.md) files. Each license has YAML front matter describing the license's properties. The body of the markdown file should be the text of the license. The available metadata fields are:

  • title - The name of the license
  • layout - This should be license
  • permalink - The absolute URL to the license, beginning with /licenses/
  • source - URL to the license source text
  • note - The note field in the sidebar (optional)
  • how - How to use the license, also in the sidebar
  • required, permitted, forbidden - bulleted list of rules applicable to the license (see below)

Rules

  • Rules (the license's properties) are stored as a bulleted list within the licenses YAML front matter. A full list of rules can be found in the repository's _config.yml file. Each rule has a name e.g., include-copyright, a human-readable label, e.g., Copyright inclusion, and a description Include the original copyright with the code. To add a new rule, simply add it to config.yml and reference it in the appropriate license.

License

The content of this project itself is licensed under the Creative Commons 3.0 license, and the underlying source code used to format and display that content is licensed under the MIT license.

choosealicense.com's People

Contributors

aroben avatar benbalter avatar haacked avatar holman avatar jdennes avatar leereilly avatar peff avatar

Watchers

 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.