Skip to content

Commit

Permalink
chore: README cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
rktjmp committed Mar 22, 2024
1 parent 87d2c34 commit 6e89655
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 31 deletions.
23 changes: 1 addition & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,27 +51,6 @@ neat("fennel") -- => "fennel is neat!"

<!-- panvimdoc-ignore-start -->

## 🎉 New

- Per-project configuration via `.hotpot.lua`
- Build to `lua/` on save, use different compiler settings per project.
- For plugin development, but can be used for configs.
- See [`h hotpot-cookbook-using-dot-hotpot`](COOKBOOK.md#using-dot-hotpot)
- `vim.loader` support
- Replaces hotpots own bytecode cache, so call `vim.loader.enable()` if you want the
fastest loading experience.
- You can still use `vim.loader` without the bytecode cache if desired, you do not
*have* to call `enable()`.
- (`vim.loader` is pretty fast without the bytecode cache.)
- `preprocessor` setup option
- Alter fennel source code before it is compiled, prefix with common imports
or functions, implement alternative module namespaces wrappers, etc..
- (Actually existed previously but now is documented).

<!-- panvimdoc-ignore-end -->

<!-- panvimdoc-ignore-start -->

## TOC

- [Requirements](#requirements)
Expand Down Expand Up @@ -127,7 +106,7 @@ if not vim.loop.fs_stat(hotpotpath) then
"--filter=blob:none",
"--single-branch",
-- You may with to pin a known version tag with `--branch=vX.Y.Z`
"--branch=v0.9.6",
"--branch=v0.11.1",
"https://github.com/rktjmp/hotpot.nvim.git",
hotpotpath,
})
Expand Down
6 changes: 3 additions & 3 deletions doc/hotpot-cookbook.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ project directory and must respecified in the `.hotpot.lua` file.
}
<

By default, Fennels compiler won't show an error if you try to reference unknown
symbols. You may prefer to enforce a known list so your builds get "hard
errors"
By default, Fennels compiler wont show an error if you try to reference
unknown symbols. You may prefer to enforce a known list so your builds get
"hard errors"

>lua
local allowed_globals = {}
Expand Down
12 changes: 6 additions & 6 deletions doc/hotpot.txt
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ likely without the runtimepath alterations.
"--filter=blob:none",
"--single-branch",
-- You may with to pin a known version tag with `--branch=vX.Y.Z`
"--branch=v0.9.6",
"--branch=v0.11.1",
"https://github.com/rktjmp/hotpot.nvim.git",
hotpotpath,
})
Expand Down Expand Up @@ -150,7 +150,7 @@ would any normal lua module.
neat("fennel") -- => "fennel is neat!"
<

Hotpot will keep an internal cache of lua code, so you won't see files
Hotpot will keep an internal cache of lua code, so you wont see files
cluttering the `lua/` directory.

You can may want to read the |hotpot-cookbook| or see more options in
Expand Down Expand Up @@ -371,9 +371,9 @@ This behaviour exists in case a plugin ships with both code in both the `lua`
and `fnl` directories, but the plugin author has post-processed the compiled
lua code, or is using an incompatible fennel version, etc.

In most cases, such as your config, Hotpot won't create `mod/lua/code.lua` and
you won't run into any issues but it may encounter friction when writing a
plugin in fennel.
In most cases, such as your config, Hotpot wont create `mod/lua/code.lua`
and you wont run into any issues but it may encounter friction when writing
a plugin in fennel.


==============================================================================
Expand All @@ -382,7 +382,7 @@ plugin in fennel.
- Hotpot will only _compile_ fennel files that are found in Neovims RTP. It
will _evaluate_ files that are found in luas `package.path`. This is for safety
purposes because it can be unclear where and when its safe to compile or
overwrite `.lua` files. In most usage this won't occur – files will be found in
overwrite `.lua` files. In most usage this wont occur – files will be found in
the RTP first but it can occur when executing in scratch buffers with the
|hotpot-api| or via |hotpot-commands|.

Expand Down

0 comments on commit 6e89655

Please sign in to comment.