From 6ba361d4f59b80c711e8033087a48de4a4b0f1e4 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Fri, 12 May 2017 13:25:12 -0700 Subject: [PATCH 1/4] goals rewrite WIP --- README.md | 35 +++++++---------------------------- 1 file changed, 7 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index ab072bb..0587281 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,20 @@ -# Choosealicense.com +**[ChooseALicense.com](http://choosealicense.com)** aims to provide **accurate**, **non-judgmental**, and **understandable** information about **open source licenses** in order to **help people make informed decisions** about the projects they start, maintain, contribute to, and use. -[![Build Status](https://travis-ci.org/github/choosealicense.com.png?branch=gh-pages)](https://travis-ci.org/github/choosealicense.com) +We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with a [Jekyll collection](https://jekyllrb.com/docs/collections/) (in `_licenses`). The catalog is used to render [ChooseALicense.com](http://choosealicense.com) and is regularly vendored into [Licensee](https://github.com/benbalter/licensee), which GitHub uses to provide a [license chooser and license detection](https://help.github.com/articles/adding-a-license-to-a-repository/), a [licenses API](https://developer.github.com/v3/licenses/), and to [display license descriptions and metadata](https://github.com/blog/2335-open-source-license-descriptions-and-metadata). -Like a Choose Your Own Adventure site, but only much less interesting. +The website navigation is -## Intro +Collaborative -A lot of repositories on GitHub.com don't have a license. GitHub provides a license chooser, but if you don't know anything about licenses, how are you supposed to make an informed decision? -[ChooseALicense.com](http://www.choosealicense.com "Choose A Licence website") is designed to help people make an informed decision about licenses by demystifying license choices through non-judgmental guidance. +[the CONTRIBUTING file](CONTRIBUTING.md#adding-a-license) -## Immediate Goals -* Non-judgmental. Our goal is to help you find a license that meets *your* goals. -* 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 to specific communities and situations. -* Not comprehensive. Seems like an odd goal, but there are a bajillion licenses out there. We're going to have to filter that down to a small list of those that matter. +## License -## Run It On Your Machine +The content of this project itself is licensed under the [Creative Commons Attribution 3.0 license](http://creativecommons.org/licenses/by/3.0/us/deed.en_US), and the underlying source code used to format and display that content is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php). -```bash -git clone https://github.com/github/choosealicense.com.git -cd choosealicense.com -script/bootstrap -script/server -``` -Open `http://localhost:4000` in your favorite browser. - -## Adding a license - -For information on adding a license, see [the CONTRIBUTING file](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). ## License metadata @@ -98,7 +81,3 @@ The license properties (rules) are stored as a bulleted list within the licenses * `liability` - This license includes a limitation of liability. * `patent-use` - This license explicitly states that it does NOT grant you any rights in the patents of contributors. * `warranty` - The license explicitly states that it does NOT provide any warranty. - -## License - -The content of this project itself is licensed under the [Creative Commons Attribution 3.0 license](http://creativecommons.org/licenses/by/3.0/us/deed.en_US), and the underlying source code used to format and display that content is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php). From 31ad0d0aa8a14c38d660ea2341a426979d48dd78 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Sun, 17 Jun 2018 16:56:07 -0700 Subject: [PATCH 2/4] fix mistaken deletion, other tweaks --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 34b4d79..4e45121 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,31 @@ -**[ChooseALicense.com](http://choosealicense.com)** aims to provide **accurate**, **non-judgmental**, and **understandable** information about **open source licenses** in order to **help people make informed decisions** about the projects they start, maintain, contribute to, and use. +**[ChooseALicense.com](https://choosealicense.com)** aims to provide **accurate**, **non-judgmental**, and **understandable** information about **open source licenses** in order to **help people make informed decisions** about the projects they start, maintain, contribute to, and use. [![Build Status](https://travis-ci.org/github/choosealicense.com.svg?branch=gh-pages)](https://travis-ci.org/github/choosealicense.com) -We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with a [Jekyll collection](https://jekyllrb.com/docs/collections/) (in `_licenses`). The catalog is used to render [ChooseALicense.com](http://choosealicense.com) and is regularly vendored into [Licensee](https://github.com/benbalter/licensee), which GitHub uses to provide a [license chooser and license detection](https://help.github.com/articles/adding-a-license-to-a-repository/), a [licenses API](https://developer.github.com/v3/licenses/), and to [display license descriptions and metadata](https://github.com/blog/2335-open-source-license-descriptions-and-metadata). +We catalog [select](CONTRIBUTING.md#adding-a-license) open source licenses with a [Jekyll collection](https://jekyllrb.com/docs/collections/) (in `_licenses`). The catalog is used to render [ChooseALicense.com](https://choosealicense.com) and is regularly vendored into [Licensee](https://github.com/benbalter/licensee), which GitHub uses to provide a [license chooser and license detection](https://help.github.com/articles/adding-a-license-to-a-repository/), a [licenses API](https://developer.github.com/v3/licenses/), and to [display license descriptions and metadata](https://github.com/blog/2335-open-source-license-descriptions-and-metadata). + +## Goals + +* Be accurate, non-judgmental, and understandable. Our goal is to help you find a license that meets *your* goals. +* The homepage should have just enough to help most folks make a decision about what license to use for a project they contribute to. +* For the rest, the site will contain additional information about licenses common to specific communities and situations. +* Collaborate with and reinforce other licensing best practices and standards projects. +* Not comprehensive. Seems like an odd goal, but there are a bajillion 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 + +```bash +git clone https://github.com/github/choosealicense.com.git +cd choosealicense.com +script/bootstrap +script/server +``` + +Open `http://localhost:4000` in your favorite browser. + +## Adding a license + +For information on adding a license, see [the CONTRIBUTING file](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). ## License metadata From 7cb93b11d2fac39db97341e65727dcf4ef875aa1 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Sun, 17 Jun 2018 16:58:36 -0700 Subject: [PATCH 3/4] rm judgmental sentence --- about.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/about.md b/about.md index a99a430..a2b463f 100644 --- a/about.md +++ b/about.md @@ -10,9 +10,9 @@ If you already know what you're doing and have a license you prefer to use, that ## Not comprehensive -This site is not a comprehensive directory of open source licenses. We think there are too many options, which adds to the confusion. On the [homepage](/), we break it down into just three licenses. The vast majority of projects will likely be fine choosing from one of these three. Just in case you have specific needs not covered by those three, we also highlight a [few other licenses to consider](/licenses/), and have a page about [licenses for non-software projects](/non-software/). +This site is not a comprehensive directory of open source licenses. On the [homepage](/), we break it down into just three licenses. The vast majority of projects will likely be fine choosing from one of these three. Just in case you have specific needs not covered by those three, we also highlight a [few other licenses to consider](/licenses/), and have a page about [licenses for non-software projects](/non-software/). -See our [appendix](/appendix) for a table of all of the licenses cataloged in the choosealicense.com repository and the links below for *even more licenses* that you **do not** need to learn about when choosing a license for your project. +See our [appendix](/appendix/) for a table of all of the licenses cataloged in the choosealicense.com repository and the links below for *even more licenses* that you **do not** need to learn about when choosing a license for your project. ### Additional resources From d5750703ae12e295ea565174a61a73352954f1b0 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Mon, 18 Jun 2018 16:17:40 -0700 Subject: [PATCH 4/4] add popular qualifier @benbalter review comment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e45121..32fddad 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**[ChooseALicense.com](https://choosealicense.com)** aims to provide **accurate**, **non-judgmental**, and **understandable** information about **open source licenses** in order to **help people make informed decisions** about the projects they start, maintain, contribute to, and use. +**[ChooseALicense.com](https://choosealicense.com)** aims to provide **accurate**, **non-judgmental**, and **understandable** information about popular **open source licenses** in order to **help people make informed decisions** about the projects they start, maintain, contribute to, and use. [![Build Status](https://travis-ci.org/github/choosealicense.com.svg?branch=gh-pages)](https://travis-ci.org/github/choosealicense.com)