initial commit

README.md

@@ -0,0 +1,39 @@
+# TMUX - configuration
+
+## Overview
+
+This project contains a tmux-configuration, that allows loading different
+plugins and layouts, that can be used to use tmux in conjunction with the helix
+editor as an integrated development environment. It can be used to edit source
+code, write texts with LaTeX and many other things. It requires the tmux plugin
+manager to be installed, in order to provide all neccessary or desired
+extensions.
+
+## Prerequisites
+
+Several packages must be available, in order to run the IDE in different
+modes/layouts:
+
+- [tmux](https://github.com/tmux/tmux/wiki): The terminal multiplexer itself
+- [git](https://git-scm.com): The git version control system
+- [tpm](https://github.com/tmux-plugins/tpm?tab=readme-ov-file): The tmux plugin
+  manager
+- [lazygit](https://github.com/jesseduffield/lazygit): A simple text based UI
+  for using git
+- [helix](https://helix-editor.com): A postmodern text editor. Replaces
+  vim/neovim.
+
+For some plugins, extra tools are required. These are optional, and only needed,
+when the plugins are installed:
+
+- [yq](https://github.com/mikefarah/yq): A commandline yaml parser. Required by
+  [tmux nerd font window name plugin](https://github.com/joshmedeski/tmux-nerd-font-window-name).
+
+## Installation
+
+Before any plugins can be loaded, it is neccesary to install the plugin-manager
+itself. This has to be done manually, and can easily be done by using git:
+
+```bash
+git clone https://github.com/tmux-plugins/tpm ~/.config/tmux/plugins/tpm
+```