Skip to content

Commit b5eb20d

Browse files
authored
chore: add third party libraries licenses (#29)
1 parent 353607a commit b5eb20d

2 files changed

Lines changed: 35 additions & 1 deletion

File tree

DEPENDENCIES.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Third-Party Dependencies and Licenses
2+
3+
This project uses several third-party libraries to function correctly. This document provides a list of these dependencies and their respective licenses.
4+
5+
## Python Dependencies
6+
7+
These libraries are used for the static site generator.
8+
9+
- **[python-frontmatter](https://github.com/eyeseast/python-frontmatter)** (MIT): Used for parsing frontmatter from Markdown files.
10+
- **[markdown](https://github.com/Python-Markdown/markdown)** (BSD-3-Clause): Used for converting Markdown content to HTML.
11+
12+
## JavaScript Dependencies (Interpreter)
13+
14+
These libraries are used by the pseudocode interpreter.
15+
16+
- **[format](https://github.com/Tidwell/format)** (MIT): String formatting utility.
17+
- **[lint](https://github.com/omni-group/lint)** (Apache-2.0): A generic linter used in the interpreter's toolset.
18+
19+
## Development Dependencies
20+
21+
These libraries are used for development, linting, and formatting of the project.
22+
23+
- **[@eslint/js](https://github.com/eslint/eslint)** (MIT): Official ESLint recommended configurations.
24+
- **[eslint](https://github.com/eslint/eslint)** (MIT): Pluggable JavaScript linter.
25+
- **[eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)** (MIT): Turns off unnecessary or conflicting ESLint rules when using Prettier.
26+
- **[eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)** (MIT): Runs Prettier as an ESLint rule.
27+
- **[globals](https://github.com/sindresorhus/globals)** (MIT): Global identifiers for different JavaScript environments.
28+
- **[prettier](https://github.com/prettier/prettier)** (MIT): Opinionated code formatter.
29+
30+
---
31+
32+
### GPL-3.0 Compatibility
33+
34+
As this project is licensed under the **GPL-3.0**, all third-party dependencies are checked for compatibility. The MIT, BSD-3-Clause, and Apache-2.0 licenses are compatible with the GPL-3.0 license.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,4 @@ npm run format
130130

131131
## License
132132

133-
This project is licensed under the GPL-3.0-only License. See `LICENSE.txt` for details.
133+
This project is licensed under the GPL-3.0-only License. See [LICENSE.txt](LICENSE.txt) for details. For a full list of third-party dependencies and their licenses, see [DEPENDENCIES.md](DEPENDENCIES.md).

0 commit comments

Comments
 (0)