diff --git a/COPYING b/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..98f72bd40794b69216031c6804b1f4d5c6369e66 --- /dev/null +++ b/COPYING @@ -0,0 +1,22 @@ +Copyright © 2019 Collabora Ltd. + +SPDX-License-Identifier: MIT + +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 0000000000000000000000000000000000000000..393fea9041122f9f5609f88098c2fd5fdf397c55 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +steam-runtime-tools — Steam Runtime integration for the Steam client +==================================================================== + +The steam-runtime-tools library provides low-level Unix-specific tools +and functionality for the Steam client. + +To support multiple architectures (currently only `i386` and `x86_64` +are supported), you will need to build it once for each architecture and +install at least the helper tools in `/usr/libexec/steam-runtime-tools-0` +(the `libsteam-runtime-tools-0-helpers` package) for every architecture +in parallel. + +The helper tools are located relative to the shared library, so it's OK +to bundle steam-runtime-tools alongside some other stack in this layout: + + anything/ + lib/ + x86_64-linux-gnu/ + libsteam-runtime-tools-0.so.0 + libexec/ + steam-runtime-tools-0/ + i386-linux-gnu-* + x86_64-linux-gnu-* + +as long as the program that is linked to `libsteam-runtime-tools-0.so.0` +can find it (via a `RPATH` or `RUNPATH` or by setting the `LD_LIBRARY_PATH` +environment variable).