Skip to content

FSF API compatible licenses.json (fixes #663) #1367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tarekchehahde wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

FSF API compatible licenses.json (fixes #663) #1367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ Open `http://localhost:4000` in your favorite browser.

If you encounter any issues with the above steps, please refer to the official [Jekyll](https://jekyllrb.com/docs/) documentation and this [guide on running Jekyll as a non-superuser](https://jekyllrb.com/docs/troubleshooting/#no-sudo) for more detailed installation instructions.

## FSF API compatible metadata

The site publishes [`api/licenses.json`](api/licenses.json) at `/api/licenses.json` after build. Regenerate it with:

```bash
script/generate_fsf_api.rb
```

The JSON follows the [FSF License Metadata API](https://wking.github.io/fsf-api/licenses-full.json) shape (`@context` + `licenses`), combining choosealicense.com rule tags with FSF identifiers where available.

## 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).
Expand Down
Loading