Liking cljdoc? Tell your friends :D

Introduction

Paravim is an editor for Clojure that...

  • Runs inside your project as a library, not as a separate application like traditional editors
  • Uses a real copy of Vim, not some kind of emulation
  • Renders its UI with OpenGL, not with a forked web browser

See the website for more info and join the discussion on /r/Paravim.

Getting Started

The easiest way to run it is with the Clojure CLI tool. On Windows or Linux, run this in any directory you want:

clojure -Sdeps "{:deps {paravim {:mvn/version \""RELEASE\""}}}" -m paravim.start

On Mac OS, you need to add a special flag:

clojure -Sdeps "{:deps {paravim {:mvn/version \""RELEASE\""}}}" -J-XstartOnFirstThread -m paravim.start

Development

  • To develop on each OS:
    • clj -A:dev:linux native
    • clj -A:dev:macos native
    • clj -A:dev:windows native
  • To run the tests on each OS:
    • clj -A:test:linux
    • clj -A:test:macos
    • clj -A:test:windows
  • To install the release version: clj -A:prod install

Licensing

All files that originate from this project are dedicated to the public domain. I would love pull requests, and will assume that they are also dedicated to the public domain.

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close