From c88042b5bf5cb2811e8c0156b044e96125b69917 Mon Sep 17 00:00:00 2001 From: nvrm <2503337+webdev23@users.noreply.github.com> Date: Tue, 27 Feb 2024 05:31:10 +0100 Subject: [PATCH] Tweaked README --- README.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c0b33b2..626a9fb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -This is Shelix IDE. +
+👀 + +### This is Shelix IDE. + Shelix does intent to maximize the hidden power of tmux as an IDE, paliate to some young age deficiencies of the very cool and incredibly efficient Helix editor, around an interactive menu that performs IDE related actions. @@ -9,8 +13,14 @@ This toolsuite is made to allow the developer to keep full control over all aspe The goal is to obtain the most of our keyboard with a symbiosis of tools that work well together. Contributions and suggestions are welcome! +
-### System dependencies + +
+👀 + +### Requirements + Generic infos are given for the Debian family, it is higly recommended to install packages from the sources, in particular to get the last versions. There is high chance that shelix runs out of the box on proprietary OS, if the blackbox has a shell and understand hashbang scripting, it's a good start. @@ -27,6 +37,8 @@ Files explorer (any of): lf, ranger, fzf (Adapting another one should be straigh `sudo apt install lf` +
+ ### Simple run Get a copy of the archive or clone using git: @@ -37,9 +49,9 @@ cd shelix ```
- +👀 -## Installation into system menus +## Installation into *system* Make sure `./.local/bin` is sourced in your *PATH* @@ -49,7 +61,7 @@ And run `./shelix.sh --install` or `shelix --uninstall`
- +👀 ### Quick usage @@ -77,7 +89,7 @@ To insert a file content into a pane that has a running Helix instance, use Ctrl
- +👀 ### Features @@ -121,7 +133,7 @@ To insert a file content into a pane that has a running Helix instance, use Ctrl
- +👀 ### Command line usage @@ -169,7 +181,7 @@ To insert a file content into a pane that has a running Helix instance, use Ctrl
- +👀 ### Shelix Keybindings @@ -223,7 +235,7 @@ Mouse actions can be triggered without focusing on the pane!
- +👀 ### Create new tools @@ -267,7 +279,7 @@ Panes related menu operations can be accessed with: ```
- +👀 ### Some useful tmux keysbindings