Skip to content
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.

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

Add instructions on how to deal with licenses #83

Merged
merged 2 commits into from
Jan 16, 2025
Merged
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions tips_tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,29 @@ Installing a library can be done with the following command:
psp-pacman -S library
```

## Managing Licenses
{: .fs-6 .fw-700 }

Every project made with the PSPDEV toolchain will import at least some libraries, each with their own license. Everything bundled is free to use, but some libraries will ask you to share their license with your project or in rare cases give users access to your code to respect their licenses. The `psp-create-license-directory` tool can be used to easily collect the licenses that apply to your project, so you can comply with them and ship them with your project.

To create a directory with a copy of the licenses that are always used in project made with the PSPDEV toolchain use the following command:

```
psp-create-license-directory
```

For any library you added, for example `sdl2` or `jsoncpp`, you can add the licenses by adding the library names to the command:

```
psp-create-license-directory sdl2 jsoncpp
```

If you're not sure what the library you used is called exactly, you can use the `-l` option to list the installed libraries:

```
psp-create-license-directory -l
```

## Updating the Toolchain
{: .fs-6 .fw-700 }

Expand Down
Loading