@@ -56,14 +56,14 @@ require('tmux-compile').setup({
5656 -- but Build and Debug will return errors informing configs are
5757 -- missing
5858 }
59- }
59+ },
6060
6161 -- Directory override config. [OPTIONAL]
62- -- If you want to set Run, Build and Debug actions for a specific directory (per project basis)
62+ -- Set actions for a specific directory (per project basis)
6363 -- Note: do not use '~' for home directory, use full path
6464 project_override_config = {
6565 {
66- project_base_dir = ' /path/to/project' ,
66+ project_base_dir = ' /absolute/ path/to/project' ,
6767 build = ' make' ,
6868 run = ' make run' ,
6969 debug = ' lldb' ,
@@ -75,6 +75,7 @@ require('tmux-compile').setup({
7575 }
7676 }
7777})
78+
7879```
7980
8081## Keybinds
@@ -111,15 +112,16 @@ vim.keymap.set('n','<F5>', ':TMUXcompile Run<CR>', {silent=true})
111112\* ** Run** here includes both compiling and running the program, depending on the
112113run command specified for the file extension.
113114
114-
115- ## Important Notice: Backward Compatibility Break
115+ < details >
116+ < summary > Important Notice: Backward Compatibility Break v1 -> v2</ summary >
116117Please note that backward compatibility is broken from Version 1 to Version 2
117118due to the implementation of a more robust configuration system. In the previous
118119version, user configuration consisted of a simple list of extensions with their
119120associated make and run command properties. However, with the introduction of
120121overlay functionality, it became necessary to add an identifier to this
121122previously unnamed list, resulting in incompatibility with older configurations.
122-
123+ < br >
123124Apologies for any inconvenience this may cause. From version 2, the plugin has been
124125designed with future-proofing in mind to ensure that such issues do not recur.
126+ </details >
125127
0 commit comments