From 9c2f079216d9c5e6b8f990f6952fd87caeb8b479 Mon Sep 17 00:00:00 2001 From: Penguin Date: Wed, 6 Mar 2024 15:31:48 -0600 Subject: [PATCH] update readme --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++----- README.org | 38 ++++++++++++++++++++++++++++++- 2 files changed, 98 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d4090af..1bb9d86 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,78 @@ # Table of Contents -1. [Background](#org55f2a10) -2. [Usage](#orgd4ac34e) +1. [Background](#org2052e5d) +2. [Prerequisites](#orgcf6f1f4) +3. [Usage](#orgca8ca43) +4. [Fonts](#org876630a) +5. [Doom Emacs](#org10bd73b) + 1. [Install Doom Emacs](#org5c95f01) + 2. [Install optional programs for doom to use](#orga4740be) + 3. [Check doom status](#org7ff8edf) - + # Background -This is my config. Maybe one day I’ll make a readme on how to use it idk +I only use gentoo now and rely on some gentoo specific packages. You’ll need to find your own alternatives to use this config. This is not a guide. This is just documentation of my setup, and it is largely incomplete. - + + +# Prerequisites + + sudo emerge -a emacs neovim + + + # Usage chmod u+x ./update-symlinks.sh ./update-symlinks.sh + + + +# Fonts + + cat << EOF | sudo tee -a /etc/portage/package.accept_keywords/config.accept + media-fonts/robotomono-nerdfont ~amd64 + media-fonts/firacode-nerdfont ~amd64 + media-fonts/jetbrainsmono-nerdfont ~amd64 + EOF + + sudo emerge -a media-fonts/robotomono-nerdfont media-fonts/firacode-nerdfont media-fonts/jetbrainsmono-nerdfont + + + + +# Doom Emacs + + + + +## Install Doom Emacs + +See instructions [here](https://github.com/doomemacs/doomemacs). + + + + +## Install optional programs for doom to use + +These are optional and based on need. Don’t use zig? Don’t emerge it. Nothing will break. + + sudo emerge -a sci-visualization/gnuplot dev-python/{black,pyflakes,isort,nose,poetry} dev-lang/zig + + + + +## Check doom status + + doom doctor + +This will let you know if you’re missing anything. + diff --git a/README.org b/README.org index ec3b25a..6b8fcfc 100644 --- a/README.org +++ b/README.org @@ -1,12 +1,48 @@ #+title: Penguin Config #+author: Penguin +#+options: toc:t * Background -This is my config. Maybe one day I'll make a readme on how to use it idk +I only use gentoo now and rely on some gentoo specific packages. You'll need to find your own alternatives to use this config. This is not a guide. This is just documentation of my setup, and it is largely incomplete. +* Prerequisites +#+begin_src bash +sudo emerge -a emacs neovim +#+end_src * Usage #+begin_src bash chmod u+x ./update-symlinks.sh ./update-symlinks.sh #+end_src + +* Fonts + +#+begin_src bash +cat << EOF | sudo tee -a /etc/portage/package.accept_keywords/config.accept +media-fonts/robotomono-nerdfont ~amd64 +media-fonts/firacode-nerdfont ~amd64 +media-fonts/jetbrainsmono-nerdfont ~amd64 +EOF + +sudo emerge -a media-fonts/robotomono-nerdfont media-fonts/firacode-nerdfont media-fonts/jetbrainsmono-nerdfont +#+end_src + +* Doom Emacs +** Install Doom Emacs +See instructions [[https://github.com/doomemacs/doomemacs][here]]. + +** Install optional programs for doom to use + +These are optional and based on need. Don't use zig? Don't emerge it. Nothing will break. +#+begin_src bash +sudo emerge -a sci-visualization/gnuplot dev-python/{black,pyflakes,isort,nose,poetry} dev-lang/zig +#+end_src + +** Check doom status +#+begin_src bash +doom doctor +#+end_src + +This will let you know if you're missing anything. +