From 6fc27c5202a264c9e26c60c50449933e8447b3ce Mon Sep 17 00:00:00 2001 From: VictorGamerLOL Date: Thu, 2 May 2024 19:12:46 +0100 Subject: [PATCH] clarified readme + mention arm support ish now --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 997b159..6f7d5d2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Suyu nix flake. +# Suyu nix flake This is a flake to allow for the installation of suyu on systems using the Nix package manager. ## Usage -Firstly, ensure git is installed in your ***system*** packages, since this is not hosted on github, gitlab, etc... It will ***not*** work with git installed in your user packages. +Firstly, ensure git is installed ***system-wide***, not just your user packages, since this is not hosted on github, gitlab, etc... It will ***not*** work with git installed in your user packages. If you are on NixOS, you must first add git to your system packages, rebuild and switch. ```nix environment.systemPackages = with pkgs; [ @@ -13,7 +13,9 @@ environment.systemPackages = with pkgs; [ ]; ``` -Add the following in your flake inputs: +Any other Linux distro or MacOS install git via its package manager. + +Then you can add the following in your flake inputs: ```nix { @@ -22,6 +24,8 @@ Add the following in your flake inputs: suyu.url = "git+https://git.suyu.dev/suyu/nix-flake"; suyu.inputs.nixpkgs.follows = "nixpkgs"; # optional, saves space, recommended + # suyu.inputs.systems.follows = "systems" # if you also have the systems flake installed, + # if you do not know what that is, you can safely ignore # more of your inputs }; @@ -30,15 +34,15 @@ Add the following in your flake inputs: Afterwards, you can add it to your user or system or user packages by referring to `suyu.packages.YOURPLATFORM.suyu` or `suyu.packages.YOURPLATFORM.default` in your flake outputs. -**Note:** This will compile the package from scratch. It can take anywhere between 5-30 minutes depending on your system. +**Note:** This will compile the package from scratch. It can take anywhere between 3-10 minutes depending on your system. --- Currently supported platforms: - [x] x86_64-linux -- [ ] aarch64-linux -- [ ] x86_64-darwin -- [ ] aarch64-darwin +- [x] aarch64-linux (untested) +- [ ] ~~x86_64-darwin~~ (suyu not ready for regular MacOS use) +- [ ] ~~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. +Feel free to submit a PR after you have tested it works on untested platforms or unsupported ones. I do not own any of the other devices and I cannot guarantee it will work on those.