Added LICENSE & README

This commit is contained in:
VictorGamerLOL 2024-05-01 21:46:55 +01:00
parent a51db39040
commit df213c424f
2 changed files with 41 additions and 0 deletions

9
LICENSE Normal file
View file

@ -0,0 +1,9 @@
Copyright 2024 Victor Rijnoveanu
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.

32
README.md Normal file
View file

@ -0,0 +1,32 @@
# Suyu nix flake.
This is a flake to allow for the installation of suyu on systems using the Nix package manager.
## Usage
Add the following in your system flake inputs:
```nix
{
inputs = {
# the rest of your inputs here
suyu.url = "git+https://git.suyu.dev/suyu/nix-flake";
suyu.inputs.nixpkgs.follows = "nixpkgs"; # optional, saves space, recommended
}
}
```
Afterwards, you can add it to your user or system packages by referring to `suyu.packages.YOURPLATFORM.suyu` pr `suyu.packages.YOURPLATFORM.default`
**Note:** This will compile the package from scratch. It can take anywhere between 5-30 minutes depending on your system.
---
Currently supported platforms:
- [x] x86_64-linux
- [ ] aarch64-linux
- [ ] x86_64-darwin
- [ ] aarch64-darwin
Feel free to submit a PR after you have tested it works on other platforms. I do not own any of the other devices and I cannot guarantee it will work on those.