Skip to content

Commit 893a405

Browse files
committed
chore: different reamde style
1 parent 6fff53f commit 893a405

File tree

3 files changed

+32
-20
lines changed

3 files changed

+32
-20
lines changed

.github/assets/footer.png

477 KB
Loading

.github/assets/header.png

1.57 MB
Loading

README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
[<img src="https://github.com/user-attachments/assets/0e1a77ac-6739-4153-bd24-abd3a5e143f5" width="200px" alt="logo" />](https://github.com/nix-darwin/nix-darwin)
1+
<p align="center">
2+
<img src=".github/assets/header.png" alt="Nix Darwin's {Modules}">
3+
</p>
24

3-
# nix-darwin
5+
<p align="center">
6+
<h3 align="center">Nix modules for darwin, `/etc/nixos/configuration.nix` for macOS.</h3>
7+
</p>
48

5-
[![Test](https://github.com/nix-darwin/nix-darwin/actions/workflows/test.yml/badge.svg)](https://github.com/nix-darwin/nix-darwin/actions/workflows/test.yml)
9+
<p align="center">
10+
<img align="center" src="https://img.shields.io/github/languages/top/xinux-org/nix-darwin?style=flat&logo=nixos&logoColor=5277C3&labelColor=ffffff&color=ffffff" alt="Top Used Language">
11+
<a href="https://github.com/xinux-org/nix-darwin/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/actions/workflow/status/xinux-org/nix-darwin/test.yml?style=flat&label=update%20(darwinpkgs)&logo=github&logoColor=5277C3&labelColor=ffffff&color=ffffff" alt="Test CI"></a>
12+
</p>
613

7-
Nix modules for darwin, `/etc/nixos/configuration.nix` for macOS.
14+
## About
815

916
This project aims to bring the convenience of a declarative system approach to macOS.
1017
nix-darwin is built up around [Nixpkgs](https://github.com/NixOS/nixpkgs), quite similar to [NixOS](https://nixos.org/).
@@ -15,18 +22,15 @@ The only prerequisite is a Nix implementation; both Nix and Lix are supported.
1522

1623
As the official Nix installer does not include an automated uninstaller, and manual uninstallation on macOS is a complex process, we recommend using one of the following installers instead:
1724

18-
* The [Nix installer from Determinate Systems](https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#determinate-nix-installer) is only recommended for use with flake-based setups.
25+
- The [Nix installer from Determinate Systems](https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#determinate-nix-installer) is only recommended for use with flake-based setups.
1926
It can install one of two distributions of Nix:
27+
- To install the **recommended** vanilla upstream [Nix](https://nixos.org), you will need to explicitly say `no` when prompted to install `Determinate Nix`.
2028

21-
* To install the **recommended** vanilla upstream [Nix](https://nixos.org), you will need to explicitly say `no` when prompted to install `Determinate Nix`.
22-
23-
* When run with the `--determinate` flag, it will install the [Determinate](https://docs.determinate.systems/) distribution.
29+
- When run with the `--determinate` flag, it will install the [Determinate](https://docs.determinate.systems/) distribution.
2430
As Determinate manages the Nix installation itself, you will need to set `nix.enable = false;` in your configuration to disable nix-darwin’s own Nix management.
2531
Some nix-darwin functionality that relies on managing the Nix installation, like the `nix.*` options to adjust Nix settings or configure a Linux builder, will be unavailable.
2632

27-
* The [Lix installer](https://lix.systems/install/#on-any-other-linuxmacos-system) supports both flake-based and channel-based setups.
28-
29-
33+
- The [Lix installer](https://lix.systems/install/#on-any-other-linuxmacos-system) supports both flake-based and channel-based setups.
3034

3135
## Getting started
3236

@@ -73,8 +77,8 @@ Add the following to `flake.nix` in the same folder as `configuration.nix`:
7377
inputs = {
7478
# Use `github:NixOS/nixpkgs/nixpkgs-25.05-darwin` to use Nixpkgs 25.05.
7579
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
76-
# Use `github:nix-darwin/nix-darwin/nix-darwin-25.05` to use Nixpkgs 25.05.
77-
nix-darwin.url = "github:nix-darwin/nix-darwin/master";
80+
# Use `github:xinux-org/nix-darwin/nix-darwin-25.05` to use Nixpkgs 25.05.
81+
nix-darwin.url = "github:xinux-org/nix-darwin/master";
7882
nix-darwin.inputs.nixpkgs.follows = "nixpkgs";
7983
};
8084
@@ -98,9 +102,9 @@ Unlike NixOS, `nix-darwin` does not have an installer, you can just run `darwin-
98102

99103
```bash
100104
# To use Nixpkgs unstable:
101-
sudo nix run nix-darwin/master#darwin-rebuild -- switch
105+
sudo nix run github:xinux-org/nix-darwin/master#darwin-rebuild -- switch
102106
# To use Nixpkgs 25.05:
103-
sudo nix run nix-darwin/nix-darwin-25.05#darwin-rebuild -- switch
107+
sudo nix run github:xinux-org/nix-darwin/nix-darwin-25.05#darwin-rebuild -- switch
104108
```
105109

106110
### Step 3. Using `nix-darwin`
@@ -129,6 +133,7 @@ nix-darwin.lib.darwinSystem {
129133
{ pkgs, lib, inputs }:
130134
# inputs.self, inputs.nix-darwin, and inputs.nixpkgs can be accessed here
131135
```
136+
132137
</details>
133138

134139
<details>
@@ -142,9 +147,9 @@ Copy the [simple](./modules/examples/simple.nix) example to `/etc/nix-darwin/con
142147

143148
```bash
144149
# If you use Nixpkgs unstable (the default):
145-
sudo nix-channel --add https://github.com/nix-darwin/nix-darwin/archive/master.tar.gz darwin
150+
sudo nix-channel --add https://github.com/xinux-org/nix-darwin/archive/master.tar.gz darwin
146151
# If you use Nixpkgs 25.05:
147-
sudo nix-channel --add https://github.com/nix-darwin/nix-darwin/archive/nix-darwin-25.05.tar.gz darwin
152+
sudo nix-channel --add https://github.com/xinux-org/nix-darwin/archive/nix-darwin-25.05.tar.gz darwin
148153

149154
sudo nix-channel --update
150155
```
@@ -173,11 +178,12 @@ You can update Nixpkgs and `nix-darwin` using the following command:
173178
```bash
174179
sudo nix-channel --update
175180
```
181+
176182
</details>
177183

178184
## Documentation
179185

180-
`darwin-help` will open up a local copy of the reference documentation, it can also be found online [here](https://nix-darwin.github.io/nix-darwin/manual/index.html).
186+
`darwin-help` will open up a local copy of the reference documentation, it can also be found online [here](https://nix-darwin.uz/manual/stable/).
181187

182188
The documentation is also available as manpages by running `man 5 configuration.nix`.
183189

@@ -235,5 +241,11 @@ The `or` operator takes care of graceful degradation when `lib` from Nixpkgs
235241
goes out of sync.
236242

237243
Feel free to contact us on Matrix if you have questions:
238-
* **User support:** [#macos:nixos.org](https://matrix.to/#/#macos:nixos.org)
239-
* **Development discussion:** [#nix-darwin-dev:nixos.org](https://matrix.to/#/#nix-darwin-dev:nixos.org)
244+
245+
- **User support:** [#macos:nixos.org](https://matrix.to/#/#macos:nixos.org) or
246+
247+
- **Development discussion:** [#nix-darwin-dev:nixos.org](https://matrix.to/#/#nix-darwin-dev:nixos.org)
248+
249+
<p align="center">
250+
<img src=".github/assets/footer.png" alt="Nix Darwin's {Modules}">
251+
</p>

0 commit comments

Comments
 (0)