diff --git a/README.md b/README.md index dc47979..5a7e2dc 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,6 @@ # Javanvim -Documentation is slowly going to move to [https://darthmoomancer.github.io/Javanvim.github.io/](https://darthmoomancer.github.io/Javanvim.github.io/) -## Why? - -The main goal is the plugin is to be simple and extensible for Java developers. Are there better plugins? Most likely, however this has simple functions for: - -- Creating New Projects -- Creating New Files (With Class Generation) -- Building Files (Currently only Main.java files) -- Running Files (Again only Main.java files) - -## Installation - -For Lazy.nvim: -```lua -require { - "DarthMooMancer/Javanvim", - config = function() - require("Javanvim").setup() - end -} -``` - -For Mini.Deps: -```lua -MiniDeps.add({ source = 'DarthMooMancer/Javanvim', name = "Javanvim" }) -require("Javanvim").setup() - -``` - -!!! You can install with any plugin manager, these are just examples. You can try this with vim, but I cant guarantee that it would work. !!! - -## Config -Currently the only thing you can change is the project root, here is how: -```lua -require...({ - project_root = "Your folder or directory" -}) -``` -- Can use whatever for example: "~/whatever" -- It will automatically make the new Root Directory, so you don't have to worry about that. -- If you want the keybinds to be included as default and able to be changed, you can request it. I dont see the need right now however. - -## Keybinds - -Javanvim doesnt come with default keybinds; however, here are the ones I use and recommend: - -```lua -vim.keymap.set("n", "jb", ":JavaBuild", { silent = true }) -vim.keymap.set("n", "jr", ":JavaRun", { silent = true }) -vim.keymap.set("n", "nf", ":NewJavaFile", { silent = true }) -vim.keymap.set("n", "np", ":NewJavaProject", { silent = true }) -``` +Documentation is here [https://darthmoomancer.github.io/Javanvim.github.io/](https://darthmoomancer.github.io/Javanvim.github.io/) ## Questions and Contributing