jonas/telekasten.nvim
1
0
Fork 0
mirror of https://github.com/Ascyii/telekasten.nvim.git synced 2026-01-01 06:14:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

move to new repo

Browse Source
This commit is contained in:
Rene Schallner
2021-11-21 02:11:10 +01:00
parent 7914a4607b
commit 67fb220931
2 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -6,16 +6,16 @@ Find notes by name, daily notes by date, search within all notes, place and foll
## Install and setup
**MS Windows note:** At the moment, telekasten is unlikely to be able to run on Windows, because it relies on a bash script. Just sayin. Since telekasten is a project that scratches my own itch, I am not sure if I will add Windows support any time soon. Should anyone read this: Pull requests are welcome 😄! Replacing the daily finder by a proper lua version should do the trick.
**MS Windows note:** At the moment, telekasten.nvim is unlikely to be able to run on Windows, because it relies on a bash script. Just sayin. Since telekasten.nvim is a project that scratches my own itch, I am not sure if I will add Windows support any time soon. Should anyone read this: Pull requests are welcome 😄! Replacing the daily finder by a proper lua version should do the trick.
### 1. Install the plugin
Install with your plugin manager of choice. Mine is [Vundle](https://github.com/VundleVim/Vundle.vim).
```vimscript
Plugin 'renerocksai/telekasten'
Plugin 'renerocksai/telekasten.nvim'
```
### 2. Configure telekasten
### 2. Configure telekaste.nvimn
Somewhere in your vim config, put a snippet like this:
```vimscript
@@ -38,12 +38,12 @@ END
```
### 3. Install the daily finder
Before using telekasten, a shell script needs to be installed. It finds and sorts notes the way we want. As long as I don't have a lua version for this functionality (this is literally the first time I use lua), we will have to stick with `daily_finder.sh`.
Before using telekasten.nvim, a shell script needs to be installed. It finds and sorts notes the way we want. As long as I don't have a lua version for this functionality (this is literally the first time I use lua), we will have to stick with `daily_finder.sh`.
Luckily, the plugin can install the daily finder for you, directly from [GitHub](https://raw.githubusercontent.com/renerocksai/telekasten/main/ext_commands/daily_finder.sh):
Luckily, the plugin can install the daily finder for you, directly from [GitHub](https://raw.githubusercontent.com/renerocksai/telekasten.nvim/main/ext_commands/daily_finder.sh):
```
:lua require('telekasten').install_daily_finder()
:lua require('telekasten.nvim').install_daily_finder()
```
This will download the daily finder into the `bin/` folder of your home directory - or the directory you specified as `my_bin` in the step above.