Update to reflect latest changes and add some more documentation
This commit is contained in:
psox
parent
a5156ed435
commit
6914904823
|
|
@ -1,7 +1,12 @@
|
|||
{
|
||||
"cSpell.words": [
|
||||
"Alacritty",
|
||||
"Coms",
|
||||
"Iosevka",
|
||||
"MYVIMRC",
|
||||
"Psox",
|
||||
"VIMHOME",
|
||||
"VIMINIT",
|
||||
"Xuyuanp",
|
||||
"adelarsq",
|
||||
"ansible",
|
||||
|
|
@ -10,7 +15,10 @@
|
|||
"junegunn",
|
||||
"luochen",
|
||||
"neoclide",
|
||||
"neovim",
|
||||
"nvim",
|
||||
"pearofducks",
|
||||
"psoxizsh",
|
||||
"rakr",
|
||||
"romainl",
|
||||
"roxma",
|
||||
|
|
@ -18,6 +26,7 @@
|
|||
"sheerun",
|
||||
"syntastic",
|
||||
"tpope",
|
||||
"vimrc",
|
||||
"yarp"
|
||||
]
|
||||
}
|
||||
58
README.md
58
README.md
|
|
@ -2,23 +2,46 @@
|
|||
|
||||
## About this
|
||||
|
||||
Over the years I have collect various bits from various locations. I often share what I have done with work colleagues and
|
||||
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
|
||||
directory and make sure you have not make any changes. If you have stash them and then run the following commands.
|
||||
Over the years I have collect various bits from various locations. I often share
|
||||
what I have done with work colleagues and finally made this repository so people
|
||||
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
|
||||
* neovim >= v0.6
|
||||
* tmux >= 3.2
|
||||
- zsh >= v5.8
|
||||
- neovim >= v0.6
|
||||
- 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`
|
||||
* `zshrc`
|
||||
* `tmux/tmux.conf`
|
||||
- `vimrc`
|
||||
- `zshrc`
|
||||
- `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
|
||||
|
||||
|
|
@ -42,7 +65,7 @@ src
|
|||
|
||||
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
|
||||
|
||||
```
|
||||
|
|
@ -54,7 +77,7 @@ git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git
|
|||
# Make sure you are root
|
||||
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
|
||||
/etc/psoxizsh/fresh-system
|
||||
|
||||
|
|
@ -62,10 +85,14 @@ git clone --recurse-submodules --recursive https://github.com/psox/psoxizsh.git
|
|||
|
||||
## 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
|
||||
|
||||
Just start neovim (`nvim`) and wait for it to finish. After that quit and it
|
||||
should be ready to use.
|
||||
|
||||
```bash
|
||||
echo $VIMINIT
|
||||
echo $MYVIMRC
|
||||
|
|
@ -73,4 +100,3 @@ echo $VIMHOME
|
|||
```
|
||||
|
||||
Enjoy
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
(
|
||||
cd ~
|
||||
[[ ! -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
|
||||
if [[ $? -ne 0 ]]
|
||||
then
|
||||
|
|
|
|||
Loading…
Reference in New Issue