Skip to content

Commit 6e444a3

Browse files
chore: delete unecessary files and update README
1 parent 2fdf93d commit 6e444a3

File tree

7 files changed

+27
-173
lines changed

7 files changed

+27
-173
lines changed

β€Ž.github/screenshot.pngβ€Ž

-271 KB
Loading

β€ŽREADME.mdβ€Ž

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,52 +18,49 @@ holds how I do it. If you are just starting out you could use mine (_I don't
1818
care or mind_, see [LICENSE][license]) but for your own sake **read them**. You
1919
will not get the most out of it without.
2020

21-
Start by reading my Neovim configuration. It follows a literate configuration
22-
where it's documentation is the configuration files it selves. I write them
23-
using markdown and Neovim will interpret only the code blocks.
21+
## 🧩 Overview
22+
23+
The configuration is as modular as I could make it so far. It is divided into `home/` and `system/` folders. The `home/` folder has everything that should work at least in any Linux distribution and even most modules should work in macOS as well (except the ones like gnome and hyprland). The `system/` contains the configuration for NixOS and I try my best to keep only the things that is really needed.
24+
25+
This configuration is as modular as I can make it. It’s split into two main
26+
directories:
27+
28+
- `home/`: portable configuration that works across any Linux distribution. Many
29+
modules even work on macOS, except for platform-specific ones like GNOME or
30+
Hyprland.
31+
32+
- `system/`: NixOS-specific configuration, containing only what’s truly
33+
necessary for the system layer (at least I try to).
2434

2535
<div align="center">
2636
<img alt="screenshot" src=".github/screenshot.png" width="85%"/>
2737
</div>
2838

29-
## :rocket: Installing
39+
## πŸš€ Installing
3040

31-
I follow a very modular approach. If you don't want something you can just
32-
remove it's folder. Imagine you don't want Neovim. You can just delete `nvim`
33-
folder. It's that simple.
41+
Every folder in `home/programs/*` is a module that brings the option
42+
`dotfiles.programs.<name>.enable` and can be activated or deactivated but commenting
43+
or setting it to false. Complex setups can easily be built by composing and
44+
reusing these modular pieces.
3445

3546
> **Warning**
36-
> As you probably know, you shouldn't just run any script that you do not trust.
37-
You shouldn't just trust my `install` script. You should read it and all the
38-
helpers that it relies on.
47+
> Helper scripts are available in the bin/ directory.
48+
> Read them before running anything β€” as always, never execute code you don’t
49+
understand or trust.
3950

4051
Start by cloning my `dotfiles` into `~/.dotfiles`. You should do the same with
41-
my `spells` repository. Some scripts needed are there.
52+
my `spells` repository. The spells are not a requirement but there's a lot of
53+
goodies there.
4254

4355
```shell
4456
git clone https://github.com/nelsonmestevao/dotfiles ~/.dotfiles
4557
git clone https://github.com/nelsonmestevao/spells ~/.spells
4658
```
4759

48-
Depending on your Linux distribution you should change the `distro.sh`
49-
accordingly.
50-
51-
```shell
52-
cd ~/.dotfiles
53-
./install
54-
```
55-
56-
## :bomb: Uninstalling
57-
58-
```shell
59-
cd ~/.dotfiles
60-
./uninstall.sh
61-
cd ~
62-
rm -rf ~/.dotfiles
63-
rm -rf ~/.spells
64-
```
60+
Then you are ready to build this configuration for your system. More
61+
documentation will be provided on exactly how to customize things.
6562

66-
## :memo: License
63+
## πŸ“„ License
6764

6865
This repository is licensed under the [WTFNMFPL](LICENSE.txt).
6966

β€Žinstallβ€Ž

Lines changed: 0 additions & 122 deletions
This file was deleted.

β€Žnotes.txtβ€Ž

Lines changed: 0 additions & 1 deletion
This file was deleted.

β€Žsystem/configuration.nixβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@
173173
telegram-desktop
174174
terraform
175175
vlc
176+
# about:config zen.view.experimental-no-window-controls
176177
zen-browser.packages.${pkgs.system}.default
177178

178179
# security

β€Žtests.shβ€Ž

Lines changed: 0 additions & 8 deletions
This file was deleted.

β€Žuninstall.shβ€Ž

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
Β (0)