Skip to content

Commit 98f0133

Browse files
committed
docs: readme
+ added missing , between build_run_config and project_override_config ~ shortened project_override_config description comments ~ moved backward compatibility comments notice to drop down thingy
1 parent 39a9b4b commit 98f0133

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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
112113
run 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>
116117
Please note that backward compatibility is broken from Version 1 to Version 2
117118
due to the implementation of a more robust configuration system. In the previous
118119
version, user configuration consisted of a simple list of extensions with their
119120
associated make and run command properties. However, with the introduction of
120121
overlay functionality, it became necessary to add an identifier to this
121122
previously unnamed list, resulting in incompatibility with older configurations.
122-
123+
<br>
123124
Apologies for any inconvenience this may cause. From version 2, the plugin has been
124125
designed with future-proofing in mind to ensure that such issues do not recur.
126+
</details>
125127

0 commit comments

Comments
 (0)