Skip to content

Commit

Permalink
add reuse/SPDX license info
Browse files Browse the repository at this point in the history
  • Loading branch information
jethrodaniel committed Sep 4, 2024
1 parent cc2cf8c commit f478fc0
Show file tree
Hide file tree
Showing 9 changed files with 74 additions and 2 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/reuse.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
#
# SPDX-License-Identifier: Zlib

name: REUSE Compliance Check

on: [push, pull_request]

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v4
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
#
# SPDX-License-Identifier: Zlib

# zig artifacts and cache
zig-out
.zig-cache
Expand Down
11 changes: 11 additions & 0 deletions LICENSES/Zlib.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
zlib License

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<!-- Copyright 2024-present, Mark Delk -->
<!-- SPDX-License-Identifier: Zlib -->
<!--
SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
SPDX-License-Identifier: Zlib
-->

# sdl.zig

Expand All @@ -8,3 +11,22 @@ Build [SDL](https://github.com/libsdl-org/SDL) using [zig](https://ziglang.org).
## License

[Zlib](https://spdx.org/licenses/Zlib.html), same as [SDL](https://github.com/libsdl-org/SDL).

### reuse

This project is using [reuse](https://reuse.software/) to ensure licensing is clear.

To update/add files:

```
reuse annotate -c "Mark Delk <[email protected]>" -l Zlib -y 2024 --copyright-style spdx-symbol --skip-existing --skip-unrecognised `fd -t f -H`
# NOTE: reuse doesn't yet support .{zig,zon} files, so do those separately
reuse annotate -c "Mark Delk <[email protected]>" -l Zlib -y 2024 --copyright-style spdx-symbol --skip-existing --style c `fd -t f | rg zig`
```

To confirm everything's in compliance:

```
reuse lint
```
4 changes: 4 additions & 0 deletions build.zig
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
//
// SPDX-License-Identifier: Zlib

const std = @import("std");

pub fn build(b: *std.Build) !void {
Expand Down
4 changes: 4 additions & 0 deletions build.zig.zon
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
//
// SPDX-License-Identifier: Zlib

.{
.name = "sdl",
.version = "0.0.0",
Expand Down
4 changes: 4 additions & 0 deletions build/wayland/build.zig
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
//
// SPDX-License-Identifier: Zlib

const std = @import("std");

pub fn build(b: *std.Build) !void {
Expand Down
4 changes: 4 additions & 0 deletions build/wayland/build.zig.zon
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
//
// SPDX-License-Identifier: Zlib

.{
.name = "wayland",
.version = "0.0.0",
Expand Down
4 changes: 4 additions & 0 deletions src/example.zig
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: © 2024 Mark Delk <[email protected]>
//
// SPDX-License-Identifier: Zlib

const std = @import("std");
const c = @import("sdl").c;

Expand Down

0 comments on commit f478fc0

Please sign in to comment.