shaeinst/roshnivim

github github
preconfigured-configuration plugin
star 29
stars
alert-circle 0
open issues
users 2
subscribers
git-branch 2
forks
CREATED

2021-07-22

UPDATED

9 hours ago

packer

require('packer').startup(function()
  use 'shaeinst/roshnivim'
end)

paq

require "paq" { 
  'shaeinst/roshnivim'
}

Contributors Issues License

Table Of Contents

About

roshnivim, can be called neovim's distro, is a predefined configs so that you don't need 1000hr to setup neovim as an IDE.

Getting Started

roshnivim can be installed by just runing a script.

Prerequisites

  • neovim >= 5.0

Installation

single command to install roshnivim

python <(curl -s https://raw.githubusercontent.com/shaeinst/roshnivim/main/setup.py)

or if you want to install it by cloning

git clone https://github.com/shaeinst/roshnivim
cd roshnivim
python setup.py

pass --delete 1 as an argument if you don't want to keep .git, README.md, LICENSE and setup.py file. Example:

python <(curl -s https://raw.githubusercontent.com/shaeinst/roshnivim/main/setup.py) --delete 1

Usage

every one has their own favourite config and keybinding. roshnivim try its best to provide likable configs and mapping. so in case you don't like to use mapping or configs by roshnivim, you can change it in override_defalut.lua file.

Project Stracture

├── extra/
│   └── snippets/                  / custom defined snippets
├── init.lua                       / use to install plugins, load configs and leader key is defined here
├── lua/
│   ├── configs.lua                / configs that's don't depends on plugins
│   ├── mappings.lua               / mappings that don't depends on plugins
│   ├── customs/
│   │   ├── override_defalut.lua   / configs to override defined config
│   │   └── roshniline.lua         / i am working on it. btw it's a status line
│   └── plugins/                   / dir containing configs for plugins. each plugin has it's own config and can be locaed through init.lua file
├── plugin/                        / auto-created by plugin manager
└── setup.py                       / python-script to install/update roshnivim

Mappings

; M to show mappings (it will show mapping in telescope) ; is a leader key. you can change it in init.lua file

License

Distributed under the MIT License.

Screenshots

screenshot_lua screenshot_running_c screenshot_telescode screenshot_codeaction screenshot_pythonlsp

To-Do

  • write Document --(one day, for sure)

Thanks to

  • shaankhan -- for readme
  • ..more will be added later

Warning!

this is not final. there is no specific rule made to follow to change in roshnivim. i will do this all later. But don't worry. if anything big is going to change, it's mapping or colors