common/README.md

58 lines
1.5 KiB
Markdown

# Configurations and Setups
Common configuration files for:
* Vim
* Emacs
* Docker images
* Fish shell
## Home Directory
Execute `setup-home.sh` to create symbolic links. Note that macOS users will
need to install `coreutils` to provide the `grealpath` utility.
### Emacs
There are configurations for Spacemacs and Doomemacs. For spacemacs,
``` sh
cp home/spacemacs/spacemacs.el ~/.spacemacs
git clone https://github.com/syl20bnr/spacemacs ~/.emacs.d
```
Note that `.spacemacs` has to be copied due to it having its own metadata. Moreover, the common repository has to reside in `~common`.
To install Doomemacs,
```
git clone https://github.com/hlissner/doom-emacs ~/.emacs.d
ln -s ~/common/home/doomemacs ~/.doom.d
~/.emacs.d/bin/doom sync
~/.emacs.d/bin/doom env
emacs --batch -f all-the-icons-install-fonts
```
## Bin
The `bin/` folder contains dockerised scripts. They should be symbolically
linked into `/usr/local/bin` via `symlinks-bin.sh`, which has to be executed as
root.
## Docker Images
* `hub-jupyter` and `hub-jupyter-spark` are images based on CUDA docker images
for jupyter. To use them with GPU, add the following to
`/etc/docker/daemon.json` and restart the docker daemon:
```json
...
"runtimes": {
"nvidia": {
"path": "/usr/bin/nvidia-container-runtime",
"runtimeArgs": []
}
}
```
* `latex` docker contains tools for compiling `latex`. It is usually not used
* due to the stability of latex.
* `route` docker is used to setup a socks5 proxy server using `ssh`.