Skip to content

Commit

Permalink
[𝚫] (README): note & warning -> new format
Browse files Browse the repository at this point in the history
  • Loading branch information
Icy-Thought committed Feb 18, 2024
1 parent 23be6ce commit 7335f27
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,9 @@ A hamerspace containing a declarative NixOS environment consisting of many
hand-crafted configurations, ranging from: Kitty, Alacritty, Doom-Emacs, Zathura
to many other applications which can be found in the `./home` directory.

> **Warning** This repository, similar to other dotfile/configuration
> repositories, is subjected to change.
>
> The reader ought to read through the commit history before blindly cloning,
> fetching or updating the necessary files required to power up their NixOS
> environment!
> [!WARNING]
> This repository, similar to other dotfile/configuration repositories, is subjected to change.
> The reader ought to read through the commit history before blindly cloning, fetching or updating the necessary files required to power up their NixOS environment!
In this README I will attempt to explain how to replicate my NixOS setup or
achieve similar feats. If you find this guide not as useful as it was designed
Expand All @@ -85,10 +82,8 @@ will be introduced later in this README._) These projects have been setup in
such manner that allows its users to carefully tune their system environments to
their liking!

> One should note that this project is still in its early stages! Henceforth one
> should familiarize themselves with the
> [Risks](https://github.com/nix-community/home-manager#words-of-warning) that
> comes with the usage of such experimental features.
> [!NOTE]
> This project is still in its early stages! Henceforth one should familiarize themselves with the [Risks](https://github.com/nix-community/home-manager#words-of-warning) that comes with the usage of such experimental features.
# Getting Started

Expand Down Expand Up @@ -138,8 +133,8 @@ https://github.com/Icy-Thought/snowflake/blob/f576ca018a7dd97e0f9d887835e2559e1e

### Remove `wgConnect` Directory

> **Note** Files contained within the `wgConnect` directory are intended for my
> personal usage.
> [!NOTE]
> Files contained within the `wgConnect` directory are intended for my personal usage.
_**Command**_ :

Expand All @@ -150,8 +145,8 @@ rm -rf ./modules/networking/wgConnect
If you choose to retain that directory, make sure to remove the files contained
within that directory and replace it with your personal WireGuard config files.

> **Warning** Failing to do so will result in `nixos-rebuild` failure because of
> the encrypted files!
> [!WARNING]
> Failing to do so will result in `nixos-rebuild` failure because of the encrypted files!
### Create Your Hosts Directory

Expand All @@ -165,8 +160,8 @@ mkdir -p hosts/X
Now create a `default.nix` file inside that folder and for the sake of speeding
the process up.

> **Note** I suggest you copy over my `thinkpad-e595/default.nix` to your
> directory (`X`) and later customize it to your liking.
> [!NOTE]
> I suggest you copy over my `thinkpad-e595/default.nix` to your directory (`X`) and later customize it to your liking.
```sh
cd hosts && cp thinkpad-e595/default.nix X
Expand All @@ -186,8 +181,8 @@ import = [ ./hardware-configuration.nix ];

### Hide Your FileSystem From Nautilus & Dolphin

> **Note** By default, Nautilus & Dolphin does not hide system partitions from
> mounted devices category.
> [!NOTE]
> By default, Nautilus & Dolphin does not hide system partitions from mounted devices category.
I have chosen to hide those partitions from the mounted devices category of the
mentioned file managers. I have also added several kernel parameters and other
Expand Down

0 comments on commit 7335f27

Please sign in to comment.