From fa8fa73946f10266a6f1b176b3cd8ac22a550832 Mon Sep 17 00:00:00 2001 From: pysan3 Date: Wed, 27 Dec 2023 00:09:55 +0900 Subject: [PATCH] add links to RSS feeds to watch for new changes --- README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index dd7ea01..be184a7 100644 --- a/README.md +++ b/README.md @@ -7,31 +7,42 @@ git clone https://github.com/pysan3/Norg-Tutorial.git cd Norg-Tutorial/ ``` -I'd suggest reading `norg_tutorial.md` first to do the installation and then clone the repo locally +I'd suggest reading [`./norg_tutorial.norg`](./norg_tutorial.norg) +first to do the installation and then clone the repo locally to read `norg_tutorial.norg` in your neovim with the neorg plugin :) -**The kickstart config is only compatible with v3.0.0+** - -Update the plugin if it is on an old version. - ## Before You Start I recommend installing these documents. -- `specifications.norg`: [https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg](https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg) +- `specifications.norg`: - Complete document about the specifications of `norg` format. - `wget https://raw.githubusercontent.com/nvim-neorg/norg-specs/main/1.0-specification.norg` - No LICENSE -- `neorg.norg`: [https://github.com/nvim-neorg/neorg/blob/main/doc/neorg.norg](https://github.com/nvim-neorg/neorg/blob/main/doc/neorg.norg) +- `neorg.norg`: - Document about how to manipulate text. e.g. **bold**, _italisize_ etc. - `wget https://raw.githubusercontent.com/nvim-neorg/neorg/main/doc/neorg.norg` - GPL v3.0 -## `norg` Tutorial +## [`norg` Tutorial](./norg_tutorial.md) - [`./norg_tutorial.norg`](./norg_tutorial.norg) - [`./norg_tutorial.md`](./norg_tutorial.md) - - Generated from `./norg_tutorial.norg`. Might be inaccurate + - Generated from `./norg_tutorial.norg`. Might be inaccurate. + +I'd suggest reading `norg_tutorial.md` first to do the installation +and then clone the repo locally to read `norg_tutorial.norg` in your neovim +with the neorg plugin :) + +## Watch for Updates + +### RSS Feeds + +- `./norg_tutorial.norg`: +- `./norg_tutorial.md`: + +### GitHub Watch + +[![GitHub watchers](https://img.shields.io/github/watchers/pysan3/Norg-Tutorial.svg?style=social&label=Watch&maxAge=2592000)](https://github.com/pysan3/Norg-Tutorial/) -I'd recommend you read `./norg_tutorial.norg` on your local neovim with tree-sitter enabled -but you can also read the conterved markdown on GitHub (which might be inaccurate). +Watch the whole repo and get notifications from GitHub.