Don't forget to star Svim repository if you found it helpful
Contributing and submitting PR's
Since svim is still pre-release, the installation process is still quite manual. For now, it has only been tested on MacOS, but should in theory work on Linux as well.
- Download or Clone the project files.
- Make sure you have cabal (a haskell build tool) installed.
- In the project directory, run:
cabal build svim
- Fetch the executable from the dist-newstyle/build/ directory. (Keep going down the hierarchy until you find the executable called 'svim').
- Move that to your /usr/local/bin/ directory (For MacOS).
The executable should be available globally.
To use svim set your preferred editor command:
svim --set-editor <editor-command>It defaults to neovim (nvim). As an example of setting that:
svim --set-editor nvimTo open a project using svim, simply type svim followed by the relative path:
svim ~/.config/nvimThis will open the project with your chosen editor, and save that file path for future use.
Svim keeps track of your most recently opened projects. Once projects are saved, simply type:
svimand a interactive menu pops up allowing you to choose from your recently opened projects
You can also save some favourite projects that you access often.
Type svim followed by the -s flag, the name you want to call it, and the filepath.
svim -s nvim_config ~/.config/nvim/You can then access these with the -f flag:
svim -fthis opens the interactive menu to let you select your project
You can also run to delete a favourite:
svim -dThis will guide you through deleting a favourite.
We love PR's!
Take a look at the CONTRIBUTING.md file for details on how to go about this!
Svim uses a semantic versioning system to increment its release version number. Using this model, changes in version numbers can help indicate the meaning of modified code for each version.
Svim is licensed under the MIT License. See the LICENSE.md for more details.
Contributions of any kind are welcome! These are our amazing contributors :)