Add README

README.md

@@ -1 +1,95 @@
-# astrovim_config
+# My [AstroNvim](https://github.com/AstroNvim/AstroNvim) config
+
+## How to install my config
+
+- First you have to install AstroNvim
+  - Backup your previous nvim config
+
+  ```bash
+  mv ~/.config/nvim ~/.config/nvimbackup
+  ```
+
+  - Clone AstroNvim repository into ~/.config/nvim
+
+  ```bash
+  git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim
+  nvim +PackerSync
+  ```
+
+- Clone my config into `~/.config/nvim/user`
+
+```bash
+git clone https://github.com/jiriks74/astronvim_config ~/.config/nvim/user
+```
+
+- Open nvim and run `:PackerSync`
+
+```bash
+nvim +PackerSync
+```
+
+## Extra plugins included
+
+- [vimspector](https://github.com/puremourning/vimspector)
+  - Simple plugin for debugging
+  - You have to create a file with `Launch` config - see the [plugin repository](https://github.com/puremourning/vimspector)
+- [vim-pio](https://github.com/jiriks74/vim-pio)
+  - PlatformIO vim plugin
+  - This is a fork that I modified to work with clangd as this is what is the
+  easiest to setup in AstroNvim
+- [vimtex](https://github.com/lervag/vimtex)
+  - A plugin for, you guessed it, LaTex
+  - I have not yet learned LaTex, so I haven't tried this plugin out.
+  Hopefully I'll learn it and try out this plugin soon
+- [markdown-preview.nvim](htps://github.com/iamcco/markdown-preview.nvim)
+  - Plugin for live markdown preview in a web browser
+- [copilot.vim](https://github.com/github/copilot.vim)
+  - Github's copilot plugin for Vim
+  - To use the plugin you have to login with this command
+    - `:Copilot setup`
+
+## Extra mappings
+
+| Shortcut |   Vim keybind   |    Description    |
+|----------|-----------------|-------------------|
+| Space+A  | ["\<leader\>a"] | Alpha Dashboard   |
+| CTRL+E   | ["\<C-e\>"]     | Copilot accept    |
+
+- Mappings for vimspector (debugging)
+
+|   Shortcut  |    Vim keybind    |     Description    |
+|-------------|-------------------|--------------------|
+|  Space+d+d  | ["\<leader\>dd"]  | Launch             |
+|  Space+d+S  | ["\<leader\>dS"]  | Stop               |
+|  Space+d+c  | ["\<leader\>dc"]  | Continue           |
+|  Space+d+p  | ["\<leader\>dp"]  | Pause              |
+|  Space+d+e  | ["\<leader\>de"]  | Reset              |
+|  Space+d+r  | ["\<leader\>dr"]  | Restart            |
+|  Space+d+R  | ["\<leader\>dR"]  | Run to cursor      |
+|  Space+d+C  | ["\<leader\>dC"]  | Go to current line |
+|  Space+d+P  | ["\<leader\>dP"]  | Move cursor to the program counter in current frame |
+|             | Breakpoints       |                    |
+| Space+d+b+t | ["\<leader\>dbt"] | Toggle breakpoint  |
+| Space+d+b+l | ["\<leader\>dbl"] | List breakpoints   |
+| Space+d+b+c | ["\<leader\>dbc"] | Clear breakpoints  |
+| Space+d+b+C | ["\<leader\>dbC"] | Toggle CBreakpoint or LogPoint on current line |
+| Space+d+b+f | ["\<leader\>dbf"] | Add a function breakpoint for expression under cursor |
+| Space+d+b+n | ["\<leader\>dbn"] | Jump to next breakpoint |
+| Space+d+b+p | ["\<leader\>dbp"] | Jump to previous breakpoint |
+|             | Step keybinds     |                    |
+| Space+d+s+s | ["\<leader\>dss"] | Step over          |
+| Space+d+s+i | ["\<leader\>dsi"] | Step into          |
+| Space+d+s+o | ["\<leader\>dso"] | Step out           |
+|             | Frame keybinds    |                    |
+| Space+d+f+u | ["\<leader\>dfu"] | Up frame           |
+| Space+d+f+d | ["\<leader\>dfd"] | Down frame         |
+
+There are also some [VSCode like keybinds setup by the plugin](https://github.com/puremourning/vimspector#visual-studio--vscode)
+
+- Mappings for markdown preview
+
+| Shortcut  |   Vim keybind    |       Description       |
+|-----------|------------------|-------------------------|
+| Space+m+p | ["\<leader\>mp"] | Markdown preview        |
+| Space+m+s | ["\<leader\>ms"] | Markdown preview stop   |
+| Space+m+t | ["\<leader\>mt"] | Markdown preview toggle |

init.lua

@@ -173,7 +173,7 @@ local config = {
     n = {
       -- second key is the lefthand side of the map
       -- mappings seen under group name "Buffer"
-      ["<leader>m"] = { "<cmd>Alpha<cr>", desc = "Alpha Dashboard" },
+      ["<leader>a"] = { "<cmd>Alpha<cr>", desc = "Alpha Dashboard" },
       ["<leader>bb"] = { "<cmd>tabnew<cr>", desc = "New tab" },
       ["<leader>bc"] = { "<cmd>BufferLinePickClose<cr>", desc = "Pick to close" },
       ["<leader>bj"] = { "<cmd>BufferLinePick<cr>", desc = "Pick to jump" },
@@ -207,6 +207,11 @@ local config = {
       ["<leader>dfu"] = { "<cmd>call vimspector#UpFrame()<cr>", desc = "Up frame" },
       ["<leader>dfd"] = { "<cmd>call vimspector#DownFrame()<cr>", desc = "Down frame" },
 
+      -- Mardown preview
+      ["<leader>mp"] = { "<cmd>MarkdownPreview<cr>", desc = "Markdown preview" },
+      ["<leader>ms"] = { "<cmd>MarkdownPreviewStop<cr>", desc = "Markdown preview stop" },
+      ["<leader>mt"] = { "<cmd>MarkdownPreviewToggle<cr>", desc = "Markdown preview toggle" },
+
       -- quick save
       -- ["<C-s>"] = { ":w!<cr>", desc = "Save File" },  -- change description but the same command
     },
@@ -241,6 +246,10 @@ local config = {
       {"puremourning/vimspector"},
       {"lervag/vimtex"},
       {"jiriks74/vim-pio"},
+      {
+        "iamcco/markdown-preview.nvim",
+        run = function() vim.fn["mkdp#util#install"]() end,
+      },
 
       -- We also support a key value style plugin definition similar to NvChad:
       -- ["ray-x/lsp_signature.nvim"] = {
@@ -334,6 +343,7 @@ local config = {
             ["s"] = { name = "Step" },
             ["f"] = { name = "Frames" },
           },
+          ["m"] = { name = "Markdown" },
         },
       },
     },