Update to reflect latest changes and add some more documentation

This commit is contained in:
psox 2022-04-01 15:18:29 +01:00
parent a5156ed435
commit 6914904823
3 changed files with 52 additions and 17 deletions

View File

@ -1,7 +1,12 @@
{ {
"cSpell.words": [ "cSpell.words": [
"Alacritty",
"Coms", "Coms",
"Iosevka",
"MYVIMRC",
"Psox", "Psox",
"VIMHOME",
"VIMINIT",
"Xuyuanp", "Xuyuanp",
"adelarsq", "adelarsq",
"ansible", "ansible",
@ -10,7 +15,10 @@
"junegunn", "junegunn",
"luochen", "luochen",
"neoclide", "neoclide",
"neovim",
"nvim",
"pearofducks", "pearofducks",
"psoxizsh",
"rakr", "rakr",
"romainl", "romainl",
"roxma", "roxma",
@ -18,6 +26,7 @@
"sheerun", "sheerun",
"syntastic", "syntastic",
"tpope", "tpope",
"vimrc",
"yarp" "yarp"
] ]
} }

View File

@ -2,23 +2,46 @@
## About this ## About this
Over the years I have collect various bits from various locations. I often share what I have done with work colleagues and Over the years I have collect various bits from various locations. I often share
finally made this repository so people can pull the latest. if you already have an installation cd to the `~/.psoxizsh` or `/etc/psoxizsh` as root what I have done with work colleagues and finally made this repository so people
directory and make sure you have not make any changes. If you have stash them and then run the following commands. can pull the latest.
This is optomized by default for dark terminals, and contains configurations for use with This is optimized by default for dark terminals, and contains configurations for
use with
* zsh >= v5.8 - zsh >= v5.8
* neovim >= v0.6 - neovim >= v0.6
* tmux >= 3.2 - tmux >= 3.2
All of these have standard setting but can be cusntomized by using optional include files. Please read the following configs All of these have standard setting but can be customized by using optional
include files. Please read the following configs
* `vimrc` - `vimrc`
* `zshrc` - `zshrc`
* `tmux/tmux.conf` - `tmux/tmux.conf`
and look at the include files to check for overides and look at the include files to check for overrides.
## Looks
For the best appearance I have tested the latest versions of
- Konsole
- Microsoft Terminal
- WezTerm
- Kitty (the Linux version, not the on based of putty)
- Alacritty (Windows and Linux)
I have previously used this on iTerm2 on MacOS but not recently.
I also use the _Iosevka Term Curly_ font on both Linux and Windows with
ligatures enabled where possible.
## Updates
If you already have an installation cd to the `~/.psoxizsh` or `/etc/psoxizsh`
as root directory and make sure you have not make any changes. If you have stash
them and then run the following commands.
```bash ```bash
@ -42,7 +65,7 @@ src
git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git ~/.psoxizsh git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git ~/.psoxizsh
# This should work on linux. It is not tested on MacOS or Windows # This should work on Linux. It is not tested on MacOS or Windows
~/.psoxizsh/fresh-system ~/.psoxizsh/fresh-system
``` ```
@ -54,7 +77,7 @@ git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git
# Make sure you are root # Make sure you are root
git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git /etc/psoxizsh git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git /etc/psoxizsh
# This should work on linux. It is not tested on MacOS or Windows # This should work on Linux. It is not tested on MacOS or Windows
# for each user that wants to use this as the user run this command # for each user that wants to use this as the user run this command
/etc/psoxizsh/fresh-system /etc/psoxizsh/fresh-system
@ -62,10 +85,14 @@ git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git
## Configure NeoVim ## Configure NeoVim
Make sure you have neovim (tested on v0.6.1) installed and after starting zsh check that the following variable are set by typing Make sure you have neovim (tested on v0.6.1) installed and after starting zsh
check that the following variable are set by typing
You will need to install `neovim`, `nodejs` and `npm` to get the full use of vim You will need to install `neovim`, `nodejs` and `npm` to get the full use of vim
Just start neovim (`nvim`) and wait for it to finish. After that quit and it
should be ready to use.
```bash ```bash
echo $VIMINIT echo $VIMINIT
echo $MYVIMRC echo $MYVIMRC
@ -73,4 +100,3 @@ echo $VIMHOME
``` ```
Enjoy Enjoy

View File

@ -2,7 +2,7 @@
( (
cd ~ cd ~
[[ ! -e ~/.zshrc ]] && touch ~/.zshrc [[ ! -e ~/.zshrc ]] && touch ~/.zshrc
install -v --mode=700 -d ~/.ssh install -v -m 0700 -d ~/.ssh
grep -E '^source (/etc/psoxizsh|~/.psoxizsh)/zshrc' ~/.zshrc 2>/dev/null >/dev/null grep -E '^source (/etc/psoxizsh|~/.psoxizsh)/zshrc' ~/.zshrc 2>/dev/null >/dev/null
if [[ $? -ne 0 ]] if [[ $? -ne 0 ]]
then then