Skip to content

INSTALL.md

Latest commit

 

History

History
81 lines (64 loc) · 3.05 KB

INSTALL.md

File metadata and controls

81 lines (64 loc) · 3.05 KB

Installation

If use Cider and Leiningen already, just jump to the section Install Oook selector and its dependencies. Otherwise, follow the steps outlined in the next section, Install prerequisites.

Install prerequisites

Install Cider

Start Emacs and run M-x package-install <Return> cider <Return>.

If it complains that cider is not available ("[No match]"), put this in your ~/.emacs or ~/.emacs.d/init.el:

(require 'package)
(add-to-list 'package-archives
             '("melpa" . "http://melpa.org/packages/") t)
(add-to-list 'package-archives
             '("melpa-stable" . "http://stable.melpa.org/packages/") t)
(add-to-list 'package-pinned-packages '(cider . "melpa-stable") t)
(package-initialize)

call M-x package-refresh-contents and try again.

Please note that we recommend to use the most recent stable version of Cider. If you want to use a more recent development version of Cider from melpa or GitHub, please have a look at the notes on that of Oook.

If you see Oook and Oook Selector complaining "Namespace not found." it probably means, that you are not using Cider Stable or that you are using a more recent Cider version without switching to the right branch of Oook.

Install Leiningen

To get Leiningen:

  • download the lein script (or on Windows lein.bat)
  • place it on your $PATH where your shell can find it (e.g., ~/bin)
  • set it to be executable:
  mkdir ~/bin
  cd ~/bin
  wget https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein
  chmod a+x ~/bin/lein

Install Oook selector and its dependencies

Get Oook selector and put it into a directory, e.g., ~/src/oook-selector:

  cd ~/src
  git clone --recursive https://github.com/xquery-mode/oook-selector.git

Put this in your ~/.emacs or ~/.emacs.d/init.el:

(require 'oook-setup  "~/src/oook-selector/oook-setup")

;; default server configuration for oook
(setq oook-connection
  '(:host "localhost" :port "8002" :user "admin" :password "admin"))

Note: oook-setup does some initialization in addition to just loading the Oook selector. If you want to do this step yourself, and just load the bare Oook selector, have a look at oook-setup.el to see how the loading is done, and replace the require 'oook-setup line by something you prefer.

Warning: Oook selector comes with its own versions of Oook, XQuery Mode, and Page Break Lines as git submodules. Make sure it does not conflict with local files in your Emacs configuration. If in doubt, remove any other version.