fix readme
This commit is contained in:
parent
5f6f9b4241
commit
4e16585c82
37
README.md
37
README.md
@ -2,46 +2,27 @@
|
||||
|
||||
> Official Godot binary packages for NixOS
|
||||
(including godot-mono for C# support!)
|
||||
> Forked from [https://github.com/ionthedev/nixos-godot-bin-4.4](https://github.com/ionthedev/nixos-godot-bin-4.4)
|
||||
> Headless version don't work, package it yourself lol
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Without Flakes ❄❌
|
||||
|
||||
The simplest way to use these packages are to use the overlay. In your `configuration.nix`:
|
||||
|
||||
let
|
||||
nixosGodot = fetchGit {
|
||||
url = "https://github.com/sgillespie/nixos-godot-bin.git";
|
||||
};
|
||||
in
|
||||
|
||||
nixpkgs.overlays = nixpkgs.overlays ++ [(import "${nixosGodot}/overlay.nix)"]
|
||||
|
||||
# <-- Snip -->
|
||||
environment.systemPackages = with pkgs; [
|
||||
godotBin
|
||||
godotMonoBin
|
||||
godotHeadlessBin
|
||||
]
|
||||
|
||||
### With Flakes ❄✅
|
||||
|
||||
#### Running Godot without installing it
|
||||
|
||||
To run Godot without any further configuration, run this command:
|
||||
|
||||
```
|
||||
nix run github:Quoteme/nixos-godot-bin
|
||||
```
|
||||
`nix run git+https://git.foglar.tech/foglar/godot-4.4.1`
|
||||
|
||||
##### Running different Godot flavors
|
||||
|
||||
There are also these other options available to run Godot:
|
||||
|
||||
```
|
||||
nix run github:Quoteme/nixos-godot-bin\#godot
|
||||
nix run github:Quoteme/nixos-godot-bin\#godotHeadless
|
||||
nix run github:Quoteme/nixos-godot-bin\#godotMono
|
||||
```sh
|
||||
nix run git+https://git.foglar.tech/foglar/godot-4.4.1\#godot
|
||||
nix run git+https://git.foglar.tech/foglar/godot-4.4.1\#godotHeadless
|
||||
nix run git+https://git.foglar.tech/foglar/godot-4.4.1\#godotMono
|
||||
```
|
||||
|
||||
Most importantly, using `\#godotMono` will allow you to write in C#.
|
||||
@ -53,7 +34,7 @@ Put this in your `flake.nix`, to install Godot for your user:
|
||||
```
|
||||
inputs = {
|
||||
# ...
|
||||
godot.url = "github:Quoteme/nixos-godot-bin";
|
||||
godot.url = "git+https://git.foglar.tech/foglar/godot-4.4.1";
|
||||
# ...
|
||||
};
|
||||
|
||||
@ -76,7 +57,7 @@ Alternatively you can also install Godot system-wide like this:
|
||||
```
|
||||
inputs = {
|
||||
# ...
|
||||
godot.url = "github:Quoteme/nixos-godot-bin";
|
||||
godot.url = "nix run git+https://git.foglar.tech/foglar/godot-4.4.1";
|
||||
# ...
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user