From 18f600785dafa96ffae24d417648249dcd581612 Mon Sep 17 00:00:00 2001 From: TuDatTr Date: Thu, 1 Feb 2018 01:03:21 +0100 Subject: [PATCH] Added an org version or the README.md --- README.md | 10 ++--- README.org | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 108 insertions(+), 7 deletions(-) create mode 100644 README.org diff --git a/README.md b/README.md index 8428cdf..953178a 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ rm -rf ~/.*bash* # remove bash-stuff from your home directory.. don't do it if y ``` ### Setting up Emacs ### -I tried to make this as easy as possible. All packages should be installed automatically. I'm not sure whether it works or not +I tried to make this as easy as possible. All packages should be installed automatically. ### Setups ### Setting up some programs. @@ -85,6 +85,8 @@ sudo ln -s ~/Downloads/Nextcloud-2.3.3-x86_64.AppImage /usr/bin/nextcloud ``` #### Finally *"installing"* the dotfiles. #### +Take a look at already existing files and delete them if necessary. + ``` shell git clone https://github.com/TuDatTr/dotfiles .dotfiles stow emacs @@ -93,12 +95,6 @@ stow zsh rm -rf ~/.i3/ sudo ln -s ~/.scripts/pipes.sh /usr/local/bin/pipes ``` -If you're using elpy you might want to do this. - -``` pip -pip install -r --user ~/dotfiles/requirements.txt -``` - # Author # * Tuan-Dat Tran - [TuDatTr](https://github.com/tudattr/) diff --git a/README.org b/README.org new file mode 100644 index 0000000..185cbb0 --- /dev/null +++ b/README.org @@ -0,0 +1,105 @@ +* dotfiles ┐【￣～￣】┌ +These are my personal dotfiles. +I'm using: + - [[https://www.gnu.org/software/emacs/][GNU Emacs]] + - [[https://www.gnu.org/software/stow][GNU stow]] + - [[https://github.com/Airblader/i3][i3-gaps]] + - [[https://manjaro.org/2017/03/07/manjaro-i3-community-edition-17-0-released/][Manjaro i3]] + - [[https://github.com/nana-4/materia-theme][Materia Theme]] + - [[http://zsh.sourceforge.net][Z shell]] + +*TODOS: + + 1. Update this README for the migration to GNU stow and clemacs + 2. Making an own [[https://github.com/brndnmtthws/conky/wiki/Configuraion-Settings][conky]], conky_maia-like + 3. Sorting the "Prerequisites" by importance + 4. Getting away from Manjaro i3 (?) + 5. Emacs Markdown preview is buggy, find another way, this would be fixed by a org-mode README + 6. Maybe convert this readme into emacs org mode + +** Getting Started +*** Prerequisites + +Pacman Install + - [[https://wiki.archlinux.org/index.php/Emacs][emacs]] - A extensible, cusotmizable, free/libre text editor - and more. + - [[https://wiki.archlinux.org/index.php/git][git]] - A free and open source distributed version control system. + - [[https://pip.pypa.io/en/stable][python-pip]] - pip to install python packages (**p**ip **i**nstalls **p**ackages) + - [[https://wiki.archlinux.org/index.php/termite][termite]] - Preferred terminal emulator, since urxvt can't handle power-line well. + - [[https://github.com/powerline/fonts][powerline-fonts]] - Powerline fonts for the Powerlevel9k-theme. + - [[https://github.com/gabrielelana/awesome-terminal-fonts][awesome-terminal-fonts]] - Font with cool icons. Necessary for powerlevel9k. + - [[https://github.com/bhilburn/powerlevel9k][zsh-theme-powerlevel9k]] - Powerlevel9k-theme for zsh. + - [[https://wiki.archlinux.org/index.php/TeX_Live][texlive-most]] - (optional)A high-quality typesetting system. + - [[https://www.mozilla.org/en-US/firefox][firefox]] - (optional) Install whatever you like, but you will need to make a change in the .config/i3/config. Let's see if waterfox is better. + - [[https://www.mozilla.org/en-US/thunderbird][thunderbid]] - (optional) Install whatever you like, but you might need to change it up in the .config/i3/config. + - [[https://veracrypt.codeplex.com][veracrypt]] - (optional) A free disk encryption software based on TrueCrypt. + - [[https://keepass.info][keepassx2]] - (optional) A free, open source, light-weight and easy-to-use password manager. + - [[https://wiki.archlinux.org/index.php/GNOME/Document_viewer][evince]] - (optional, prefered if you use auctex) pdf viewer, default to view compiled LaTeX-files with auctex(emacs plugin). + - [[https://wiki.archlinux.org/index.php/backlight][xorg-backlight]] - The backlight controlling tool I use + - [[https://wiki.archlinux.org/index.php/PulseAudio][pulseaudio-alsa]] - (recommended) + - [[https://wiki.archlinux.org/index.php/PulseAudio][pulseaudio-bluetooth]] - (recommended) + - [[http://www.nyan.cat/][nyancat]] - (mandatory) That's what the internet is all about. + - [[https://wiki.archlinux.org/index.php/Cmus][cmus]] - (optional) cli music player + - [[https://www.gnu.org/software/stow/][stow]] - To manage dotfiles + - aspell-en - Language for flycheck + - aspell-de -Language for flycheck + - [[https://lxde.org][lxappearance]] - Feature-rich GTK+ theme switcher of the LXDE Desktop + +Pacman Remove + - [[https://www.palemoon.org][palemoon-bin]] - Not needed anymore, if you use Firefox. + - [[https://github.com/jristz/epdfview][epdfview]] - Not needed anymore, if you use evince. + +Yaourt Install + - [[https://github.com/PandorasFox/i3lock-color][i3lock-color]] - Needed for ~/.scripts/i3lock.py + - [[https://github.com/karlstav/cava][cava]] - *C* onsole-based *A* udio *V* isualizer for *A* LSA (MPD and Pulseaudio) + - [[https://github.com/nana-4/materia-theme][materia-theme]] - A Material Design theme for GNOME/GTK+ based desktop environments + +#+BEGIN_SRC sh +sudo pacman -Syu +sudo pacman -S emacs git termite python-pip zsh-theme-powerlevel9k powerline-fonts awesome-terminal-fonts texlive-most firefox thunderbird evince veracrypt keepassx2 xorg-xbacklight pulseaudio-alsa pulseaudio-bluetooth nyancat cmus lxappearance +sudo pacman -R palemoon-bin epdfview +yaourt -S i3lock-color cava materia-theme +#+END_SRC + +*** Setting up zsh +#+BEGIN_SRC sh +chsh -s /bin/zsh +sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" # Downloading/Installing oh-my-zsh +cp -r /usr/share/zsh-theme-powerlevel9k ~/.oh-my-zsh/themes/powerlevel9k # copying powerlevel9k-theme to the desired directory +rm -rf ~/.*bash* # remove bash-stuff from your home directory.. don't do it if you wanna keep using bash +#+END_SRC + + +*** Setting up Emacs +I tried to make this as easy as possible. All packages should be installed automatically. + +*** Setups +Setting up some programs. +**** Installing Nextcloud-Client (optional) + +#+BEGIN_SRC sh +wget https://download.nextcloud.com/desktop/releases/Linux/Nextcloud-2.3.3-x86_64.AppImage --P ~/Downloads/ +chmod +x ~/Downloads/Nextcloud-2.3.3-x86_64.AppImage +sudo ln -s ~/Downloads/Nextcloud-2.3.3-x86_64.AppImage /usr/bin/nextcloud +#+END_SRC + +#### Finally *"installing"* the dotfiles. #### +Take a look at already existing files and delete them if necessary. +Like ~\~/.i3/~ +#+BEGIN_SRC sh +git clone https://github.com/TuDatTr/dotfiles .dotfiles +stow emacs +stow i3 +stow zsh +sudo ln -s ~/.scripts/pipes.sh /usr/local/bin/pipes +#+END_SRC + +* Author + - Tuan-Dat Tran - [[https://github.com/tudattr/][TuDatTr]] + +* License +This project is license under the GPL-3.0 License - see LICENSE file for details. + +* Acknowledgements + - [[https://www.reddit.com/r/unixporn/][unixporn - the home for *NIX customisation!]] + - [[https://uigradients.com][uiGradients - Beautiful colored gradients]] + - [[http://terminal.sexy/][terminal.sexy - Terminal Color Scheme Designer]]