From 57bff6e707779099befa2ac0474fa696ffc6a6a5 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 5 Oct 2024 08:27:32 -0400 Subject: [PATCH] docs: add readme and license --- LICENSE | 21 +++++++++++++++++++++ README.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..92f562ae --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 LizardByte + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..953e5e89 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# build-deps + +[![GitHub Workflow Status (FFmpeg)](https://img.shields.io/github/actions/workflow/status/lizardbyte/build-deps/build-ffmpeg.yml.svg?branch=master&label=ffmpeg%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/build-deps/actions/workflows/build-ffmpeg.yml?query=branch%3Amaster) + +This is a common set of pre-compiled dependencies for LizardByte/Sunshine. + +- [FFmpeg](https://ffmpeg.org) + +## Usage + +1. Add this repository as a submodule to your project. + + ```bash + git submodule add https://github.com/LizardByte/build-deps.git third-party/build-deps + cd third-party/build-deps + git submodule update --init --recursive + checkout dist + ``` + +## Plans + +- [ ] Convert to a cmake project +- [ ] Add more dependencies + - [ ] boost + - [ ] cuda (developer toolkit) +- [ ] build linux dependencies in Docker (to more closely align with target environments) + +## License + +This repo is licensed under the MIT License, but this does not cover submodules or patches. +Please see the individual projects for their respective licenses.