aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorPreston Pan <preston@nullring.xyz>2024-03-01 23:59:45 -0800
committerPreston Pan <preston@nullring.xyz>2024-03-01 23:59:45 -0800
commitff214773f5752bef66e5ac5fd666dafd6b5ac271 (patch)
treea6c8f2dc14d0687f4c4820832d1d53beed7f376b /README.org
parent9551c7d783b76edff579287238ab3b85d37efe25 (diff)
change readme
Diffstat (limited to 'README.org')
-rw-r--r--README.org39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.org b/README.org
index c3133ae..6e2a7b3 100644
--- a/README.org
+++ b/README.org
@@ -20,5 +20,44 @@ as well as writing a lot of things with a literate config.
** So, where is this website of yours located?
https://ret2pop.nullring.xyz, it is the road to enlightenment.
+* Wait, so where are your dotfiles?
+To use my dotfiles, clone this repository:
+#+begin_src bash
+git clone https://github.com/ret2pop/ret2pop-website.git ~/org/website
+#+end_src
+and install my ~configuration.nix~ file. The org files /are/ the dotfiles, or
+at least in the case of emacs.
+
+To use my full system, you also need to have a ~password-store~ from the ~pass~
+password manager in its standard location with an entry called ~Mail~, and you need
+to clone my [[https://github.com/ret2pop/wallpapers.git][wallpapers]] repository. Therefore, in full, my configuration can be fully
+installed like so:
+#+begin_src bash
+ # Run this in root, and after copying the configuration.nix file and running nixos-rebuild switch.
+ # You must also change the gpg key used for git and pass. Make sure
+ # you've installed your gpg keys and your ssh keys before this.
+ # Install your music to ~/music. Of course, also change your location
+ # of stuff like your mail server.
+ su preston # if you change your username, change this too
+ cd ~
+ mkdir ~/org
+ # if you want to make this process deterministic, clone a particular commit
+ git clone https://github.com/ret2pop/ret2pop-website.git ~/org/website
+ git clone https://github.com/ret2pop/wallpapers.git
+ # replace this with your password-store
+ git clone git@nullring.xyz:/var/www/password_store.git ~/.password-store/
+ mbsync prestonpan # change this with your own name in the nix config and here
+ # TODO: mu init/index
+ mpc add /
+
+ # Afterwards, open firefox, enable all the plugins that are already installed,
+ # and install the catppuccin firefox theme. For vencord, use the catppuccin
+ # betterdiscord theme; open emacs and run pdf-tools-install, nerd-icons-install-fonts,
+ # and all-the-icons-install-fonts. These things are not completely set up for you but
+ # the good news is that the vast majority of the functionality is included.
+
+#+end_src
+Without the comments, it is a 10 line program that installs everything needed to run my system,
+and configures those programs as well!
* License
See the [[file:LICENSE.org][license]]. The style.css has its own license.