Skip to content

Commit 107ef3e

Browse files
northdakotagnorthdakotag
committed
README.md: update
1 parent 8b86785 commit 107ef3e

File tree

1 file changed

+43
-40
lines changed

1 file changed

+43
-40
lines changed

‎README.md

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,32 @@
2828
* [License](#license)
2929
* [Screenshots](#screenshots)
3030
* [To-do](#to-do)
31-
* [#Warning](#warning)
3231

33-
![screenshot_welcome](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/roshnivim-welcom.png)
3432

3533
## About
3634
<div align="center"
3735
roshnivim -> roshni + vim -> light + vim (roshni means light in hindi/urdu) <br>
3836
logo-style -> rosh(n)i(vim) <br>
3937
</div>
4038
<br>
41-
4239
roshnivim, can be called neovim's distro, is a predefined configs so that you don't need 1000hr to setup neovim as an IDE. <br><br><br>
4340

41+
![screenshot_welcome](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/roshnivim-welcom.png)
42+
43+
## Features
44+
- ```Project based config loading``` ( you can define configs in ```.__nvim__.lua``` file in the root of your working project so that you don't have to change config everytime you work on new/seperate project )
45+
- ```Your own custom configs and Mappings``` (if you don't like roshnivim's default config/mapping, you can change/override it on [override_defalut.lua](https://github.com/shaeinst/roshnivim/blob/main/lua/customs/override_defalut.lua) OR ```~/.__nvim__.lua``` file )
46+
- ```Separate config file for each plugins``` each plugin has their own config file which is defined in lua/plugins directory
47+
- ```Easily Disable plugin``` roshnivim's using [packer](https://github.com/wbthomason/packer.nvim) as plugin manager. conmmenting out ```config``` option from plugin options in [packer config file](https://github.com/shaeinst/roshnivim/blob/main/lua/plugins/packer_nvim.lua) will disable that plugin
48+
- ```Easy Installation``` install roshnivim with single command
4449

45-
## Getting Started
4650

51+
## Getting Started
4752
roshnivim can be installed by just runing a script.
4853

4954
#### Prerequisites
5055

51-
* neovim >= 5.0
56+
* neovim >= 6.0
5257

5358
#### Installation
5459

@@ -68,34 +73,37 @@ Example:
6873
python <(curl -s https://raw.githubusercontent.com/shaeinst/roshnivim/main/setup.py) --delete 1
6974
```
7075

71-
<br>
72-
NOTE1:<br>
76+
NOTE1:
7377
it could take some time depending on you connection (it's going to install plugins and some LSs).<br>
74-
So, be patient and follow the output throw by setup.sh script<br><br>
75-
NOTE2:<br>
76-
only some LSs are going to be installed. for more, install with [LspInstall](https://github.com/williamboman/nvim-lsp-installer)
77-
<br>
78-
for example: to install C/C++'s LS ```:LspInstall clangd```
78+
So, be patient and follow the output throw by setup.py script<br><br>
79+
NOTE2:
80+
only some LSs are going to be installed. for more, install with [LspInstall](https://github.com/williamboman/nvim-lsp-installer) <br>
81+
for example: to install C/C++'s LS ``` :LspInstall clangd ```
7982
<br><br>
8083

8184

85+
8286
## Usage
83-
every one has their own favourite config and keybinding. roshnivim try its best to provide likable configs and mapping.
87+
every one has their own favourite configs and keybindings. roshnivim try its best to provide likable configs and mapping.
8488
<br>
8589
so in case you don't like to use mapping or configs by roshnivim, you can change it in [override_defalut.lua](https://github.com/shaeinst/roshnivim/blob/main/lua/customs/override_defalut.lua) file. <br>
8690

8791
### Project Stracture
8892
```
8993
├── extra/
90-
│   └── snippets/ / custom defined snippets
91-
├── init.lua / use to install plugins, load configs and leader key is defined here
94+
│ └── snippets/ / custom defined snippets
95+
│ ...
96+
├── init.lua / load/source configs | heart of roshnivim
9297
├── lua/
93-
│   ├── configs.lua / configs that's don't depends on plugins
94-
│   ├── mappings.lua / mappings that don't depends on plugins
95-
│   ├── customs/
96-
│   │   ├── override_defalut.lua / configs to override defined config
97-
│   │   └── roshniline.lua / i am working on it. btw it's a status line
98-
│   └── plugins/ / dir containing configs for plugins. each plugin has it's own config and can be locaed through init.lua file
98+
│ ├── configs.lua / configs that's don't depends on plugins
99+
│ ├── mappings.lua / mappings that don't depends on plugins
100+
│ ├── customs/
101+
│ │ ├── project_env.lua / load configs from .__nvim__.lua file defined in any project you're working on
102+
│ │ ├── override_defalut.lua / configs to override defined config
103+
│ │ └── roshniline.lua / i am working on it. btw it's a status line
104+
│ └── plugins/ / dir containing configs for plugins. each plugin has it's own config and can be locaed through init.lua file
105+
│ └── packer_nvim.lua / manage plugins
106+
│ ...
99107
├── plugin/ / auto-created by plugin manager
100108
└── setup.py / python-script to install/update roshnivim
101109
```
@@ -109,35 +117,30 @@ Distributed under the MIT License.
109117
<br><br>
110118

111119
## Screenshots
112-
113-
<details close><summary>expand</summary>
114-
115-
![screenshot_lua](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/init.lua.png)
120+
![screenshot_lua](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/buff_and_nerdtree.png)
121+
![screenshot_pythonlsp](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/python_lsp.png)
116122
![screenshot_running_c](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/running_c.png)
117123
![screenshot_telescode](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/telescope_as_fuzzy_finder.png)
124+
![screenshot_lua](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/packer.png)
118125
![screenshot_codeaction](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/codeaction_in_flutter_app.png)
119-
![screenshot_pythonlsp](https://raw.githubusercontent.com/shaeinst/media/main/images/github-repositories/roshnivim/python_lsp.png)
120-
121-
</details>
122126

123127

124128

125129
<br>
126130

127131
## To-Do
128-
- load config from .__nvim__.lua file if it's defined in project
129-
- write Document --(one day, for sure)
130-
131-
## Thanks to
132-
- [shaankhan](https://readme.shaankhan.dev/) -- for readme
133-
- ..more will be added later
132+
- write decent documentation
134133

135-
<br>
136-
137-
## Warning!
138-
this is not final. there is no specific rule made to follow to change in roshnivim. i will do this all later. <br>
139-
But don't worry. if anything big is going to change, it's mapping or colors
140134

141135
## Known Bugs
142-
- shows false line number status
136+
- shows false line number on status line (sometime)
137+
143138

139+
## Thanks to
140+
- [Neovim](https://github.com/neovim/) -- for awesome EDITOR
141+
- [shaankhan](https://readme.shaankhan.dev/) -- for readme
142+
- [Neovim-Subreddit](https://www.reddit.com/r/neovim/) -- for awesome supporting community
143+
- [LunarVim](https://github.com/LunarVim/LunarVim) -- for some reference
144+
- Plugin Authors -- without you, neovim is incomplete
145+
- and YOU
146+
<br>

0 commit comments

Comments
 (0)