Skip to content

Commit d411202

Browse files
committed
Update paths from the default config and document .fnlm files
1 parent 0bc0fcf commit d411202

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ fine!) will default to these values that should work fine for most people.
104104
;; See :rtp-patterns below for more information on including other plugins in your path.
105105
106106
;; String to set the compiler's fennel.path to before compilation.
107-
:fennel-path "./?.fnl;./?/init.fnl;./fnl/?.fnl;./fnl/?/init.fnl"
107+
:fennel-path "/home/.../?.fnlm;/home/.../?/init.fnlm;/home/.../fnl/?.fnlm;/home/.../fnl/?/init.fnlm;/home/.../?.fnl;/home/.../?/init.fnl;/home/.../?/init-macros.fnl;/home/.../fnl/?.fnl;/home/.../fnl/?/init.fnl;/home/.../fnl/?/init-macros.fnl"
108108
109109
;; String to set the compiler's fennel.macro-path to before compilation.
110-
:fennel-macro-path "./?.fnl;./?/init-macros.fnl;./?/init.fnl;./fnl/?.fnl;./fnl/?/init-macros.fnl;./fnl/?/init.fnl"
110+
:fennel-macro-path "/home/.../?.fnlm;/home/.../?/init.fnlm;/home/.../fnl/?.fnlm;/home/.../fnl/?/init.fnlm;/home/.../?.fnl;/home/.../?/init.fnl;/home/.../?/init-macros.fnl;/home/.../fnl/?.fnl;/home/.../fnl/?/init.fnl;/home/.../fnl/?/init-macros.fnl"
111111
112112
;; A list of glob patterns (autocmd pattern syntax) of files that
113113
;; should be compiled. This is used as configuration for the BufWritePost
@@ -202,12 +202,7 @@ documentation rendering time that we may not want.
202202

203203
## Macros
204204

205-
Fennel allows you to write inline macros with the `(macro ...)` form but they're
206-
restricted to only being used in that one file. If you wish to have a macro
207-
module shared by the rest of your codebase you need to mark that file as a macro
208-
module by placing `;; [nfnl-macro]` somewhere within the source code. The exact
209-
amount of `;` and whitespace doesn't matter, you just need a comment with
210-
`[nfnl-macro]` inside of it.
205+
Fennel allows you to write inline macros with the `(macro ...)` form but they're restricted to only being used in that one file. If you wish to have a macro module shared by the rest of your codebase you need to mark that file as a macro module either by giving it the `.fnlm` suffix or by placing `;; [nfnl-macro]` somewhere within the source code. The exact amount of `;` and whitespace doesn't matter, you just need a comment with `[nfnl-macro]` inside of it.
211206

212207
This marker does two things:
213208

@@ -219,11 +214,10 @@ This marker does two things:
219214
your macro modules stays in sync and you never end up having to find old Lua
220215
that was compiled with old versions of your macros.
221216

222-
For example, here's a simplified macro file from nfnl itself at
223-
`fnl/nfnl/macros.fnl`.
217+
For example, here's a simplified macro file from nfnl itself at `fnl/nfnl/macros.fnlm`.
224218

225219
```fennel
226-
;; [nfnl-macro]
220+
;; [nfnl-macro] <-- is only required if you don't use the `.fnlm` extension.
227221
228222
;; .nfnl.fnl config so you don't need to prefix globals like _G.vim.*
229223
;; {:compiler-options {:compilerEnv _G}}

0 commit comments

Comments
 (0)