You've already forked faultynotes
init: Creation of the plugin skeleton
This commit is contained in:
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.luacheckcache
|
||||
9
LICENSE
Normal file
9
LICENSE
Normal file
@@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright © 2026 FaultyBranches
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# FaultyNotes (title WIP)
|
||||
|
||||
A custom and pared down note taking plugin for the Neovim editor (targetting v0.12+) based on the Zettelkasten style, built to rely upon Neovim native functionality and minimal optional additions (such as Telescope integration).
|
||||
|
||||
## Installation
|
||||
|
||||
### vim.pack
|
||||
|
||||
```lua
|
||||
vim.pack.add({
|
||||
'https://git.faultybranches.dev/FaultyBranches_Public/faultynotes.git'
|
||||
})
|
||||
```
|
||||
|
||||
## Init and Configuration
|
||||
|
||||
```lua
|
||||
require('faultynotes').setup()
|
||||
```
|
||||
0
lua/faultynotes.lua
Normal file
0
lua/faultynotes.lua
Normal file
Reference in New Issue
Block a user