CRAG666 / code_runner.nvim

Neovim plugin.The best code runner you could have, it is like the one in vscode but with super powers, it manages projects like in intellij but without being slow
MIT License
534 stars 38 forks source link

Refactoring README for better readability #83

Closed saccarosium closed 1 year ago

saccarosium commented 1 year ago

Hi, This PR makes the following changes:

Also I would like to know your thoughts on what documentation you will confident maintaining. At the moment we are using both README and vimdoc internal documentation, that seems to be very outdated and not useful. As I see it we can go with 3 different approaches:

  1. Remove the vimdoc and maintain only the README;
  2. Remove the documentation from the README and maintain only the vimdoc;
  3. We maintain only the README and out generate the vimdoc, manually or automatically with pandoc.
CRAG666 commented 1 year ago

I choose option 3