Skip to content

ritchielrez/oh-my-nvim

Repository files navigation

Oh-my-nvim

A work in progress personal neovim config
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. Showcase
  2. About The Project
  3. Getting Started
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

Showcase

(back to top)

About The Project

There are many neovim distrobutions (custom configs made by others) avalaible for anyone use to out there. Those are great, because often they are made by those who know more about neovim and understand the way the editor works better than the rest. If you don't want to have the burden of maintaining a config it is fine to use a premade config, but for me I always liked configuring something by myself, only getting inspired (copying XD) from others when I don't want to spend time on something or something is really confusing. This neovim config is made by myself for myself, but there are a lot of things that are in the config that I took from other people's config, yet I am really proud of my neovim config. Because there are things that I learned while making this config, and I will continue to learn. Neovim for me is not just an editor, but also something that I can control and make it work how I want it to work.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

A list of things that you need to have in your system in order to use this project.

  • Git

Installation

  1. Create a backup of your current neovim config (if you have one) somewhere else

  2. Clone the repo

    Linux / Mac

    git clone https://github.com/ritchielrez/oh-my-nvim ~/.config/nvim/

    Windows (in powershell)

    git clone https://github.com/ritchielrez/oh-my-nvim ~/AppData/Local/nvim
  3. Start up neovim

    nvim

(back to top)

Roadmap

  • Lock plugins to specific commits
  • If possible, make this config perform better in Windows

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

Thanks to all of this projects for helping me to make this project better.

(back to top)

About

A new rewrite of my WIP neovim config

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published