• emacs >=26
• mongoDB >=4.2
• (optional) python >=3 and some libraries (see utils/requirements.txt), for generating corpus data yourself (you might want to use data sent to you by someone else, hence python’s optionality)

• Download and install emacs – instructions here.
• Clone this repository (how-to) to your home directory ; If you don’t know what your home directory is, you can run

  M-x eval-expression RET (expand-file-name "~/")
      

  in your Emacs (see Emacs key notation if in doubt); the resulting path is your home directory.

• Copy the file .emacs.d/init.el in this repository to an .emacs.d directory in your home directory (if it doesn’t exist yet, create it).
• See Usage for how to configure sensetion before use.

• Clone this repository – preferentially to your home directory.
• The file at .emacs.d/init.el in this repository has comments specifying code you should include in your init file to have sensetion.el running smoothly. In summary you must install dependencies from MELPA and ELPA, and tell emacs where this library and the annotation files are in your file system (unless you placed them in the default locations in your home directory). If you are using a Mac, you might also need the package exec-path-from-shell, available from MELPA.
• Restart emacs (or reload or your init file).
• See Usage for how to configure sensetion before use.

sensetion.el uses MongoDB as its database backend.

First, ensure that mongod and mongo are installed. When you start using sensetion.el, you must make sure that:

• mongod is running;
• mongo is available on your PATH variable:
  • to add mongo to your PATH on windows, follow these instructions
  • to add mongo to your PATH on a Mac/Unix/Linux, follow these instructions. If on Mac, make sure you have this library installed (you should have if you copied the template .emacs.d/init.el file in this repository)
  • on any platform, a change to the PATH variable may not be picked up by Emacs immediately; a sure-fire (but overkill) way of fixing this is by restarting your computer, but restarting Emacs from a newly-spawned shell usually works.

See the Data page to see how to generate data for and insert data in the backend.

In MacOS, MongoDB can be installed with homebrew and started with

brew services restart mongodb-community