From 0909ba71710bf7ebc9c313be282bdc213825f8fe Mon Sep 17 00:00:00 2001 From: luyanfcp Date: Sun, 13 Aug 2023 00:40:06 +0800 Subject: [PATCH] :construction: update readme --- .github/FUNDING.yml | 3 - .pre-commit-config.yaml | 15 ---- README.md | 166 +--------------------------------------- 3 files changed, 3 insertions(+), 181 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 .pre-commit-config.yaml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index fc97089..0000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,3 +0,0 @@ -github: glepnir -custom: ['https://www.paypal.me/bobbyhub'] - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 0ad15e3..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,15 +0,0 @@ -# See https://pre-commit.com for more information -# See https://pre-commit.com/hooks.html for more hooks -repos: -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v3.2.0 - hooks: - - id: trailing-whitespace - - id: end-of-file-fixer - - id: check-yaml - - id: check-added-large-files - -- repo: https://github.com/Koihik/LuaFormatter.git - rev: master - hooks: - - id: luaformatter diff --git a/README.md b/README.md index 6b5e1b1..8c36f35 100644 --- a/README.md +++ b/README.md @@ -1,167 +1,7 @@ -

- - dope - -

+# My Nvim Config -

- - Stargazers - - - Issues - - - Contributors - -

+## Introduce -

- -

- -## What is dope - -Many people are interested in my [personal configuration](https://github.com/glepnir/nvim). So I created dope. - -What does dope do? dope wants vimers to have their own config with high performance - -fast speed and modernity. - -## Structure - -``` -├── init.lua -├── lua -│   ├── core -│   │   ├── cli.lua -│   │   ├── helper.lua -│   │   ├── init.lua -│   │   ├── keymap.lua -│   │   ├── options.lua -│   │   └── pack.lua -│   ├── keymap -│   │   ├── config.lua -│   │   └── init.lua -│   └── modules -│   ├── completion -│   │   ├── config.lua -│   │   └── package.lua -│   ├── editor -│   │   ├── config.lua -│   │   └── package.lua -│   ├── tools -│   │   ├── config.lua -│   │   └── package.lua -│   └── ui -│   ├── config.lua -│   └── package.lua -├── snippets -│   ├── lua.json -│   ├── lua.lua -│   └── package.json -``` - -- `core` heart of dope it include the api of dope -- `modlues` plugin module and config in this folder -- `snippets` vscode snippets json file - -## Usage - -- Click button `Use this template` It will generate a new repo based on dope on your GitHub - -### Cli tool - -`bin/dope` is a cli tool for dope config. run `./bin/dope help` check more detail - -you can use `/bin/dope debug ui,editor` for debug modues. when you get trouble -this is useful for your debug, this command mean disable `ui editor` modules.Then -the plugins in `ui,editor` modules not load. - -## How to install plugins - -dope use [lazy.nvim](https://github.com/folk/lazy.nvim) as package management plugin. register a plugin in `package.lua` by using dope api `require('core.pack').package`. more usage check the -lazy.nvim doc and you can some examples in package.lua file. - -### How to create module - -create a fold inside `modlues` folder and `package.lua` file you must created inside your module. -dope will auto read this file at startup. - - -### How to config keymap - -In dope there are some apis that make it easy to set keymap. All apis are defined in `core/keymap.lua`. - -```lua -keymap.(n/i/c/v/x/t)map -- function to generate keymap by vim.keymap.set -keymap.new_opts -- generate opts into vim.keymap.set --- function type that work with keymap.new_opts -keymap.silent keymap.noremap keymap.expr keymap.nowait keymap.remap -keymap.cmd -- just return string with and -keymap.cu -- work like cmd but for visual map -``` - -Use these apis to config your keymap in `keymap` folder. In this folder `keymap/init.lua` is necessary but if you - -have many vim mode remap you can config them in `keymap/other-file.lua` in dope is `config.lua` just an - -example file. Then config plugins keymap in `keymap/init.lua`. the example of api usage - -```lua --- generate keymap in noremal mode -nmap { - -- packer - {'pu',cmd('Lazy update'),opts(noremap,silent,'Lazy update')}, - {"",'h',opts(noremap)}, - -} - -also you can pass a table not include sub table to `map` like - -```lua -nmap {'key','rhs',opts(noremap,silent)} -``` - -use `:h vim.keymap.set` to know more about. - -## Tips - -- Improve key repeat - -``` -mac os need restart -defaults write NSGlobalDomain KeyRepeat -int 1 -defaults write NSGlobalDomain InitialKeyRepeat -int 10 - -linux -xset r rate 210 40 -``` - -## Donate - -[![](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/bobbyhub) - -If you'd like to support my work financially, buy me a drink through [paypal](https://paypal.me/bobbyhub) +My personal Nvim Config base on [dope](https://github.com/nvimdev/dope) ## Licenese MIT