Source

js-elisp / README

-*- org -*-

Jane Street Emacs utilities

Linux note: I couldn't get omake to install with FAM support
via opam or from source.  The only way it worked was via apt.

* Usage

** Normal usage at the office

Everyone should add one of the following lines to their .emacs file.

      (load "/j/office/app/emacs/prod/jane-elisp/elisp/jane/jane-defaults")
        loads libraries, sets variables according to our coding
        standards, and sets standard defaults which many users find
        useful.

      (load "/j/office/app/emacs/prod/jane-elisp/elisp/jane/jane-common")
        leaves discretionary settings to the user.

** Beta testers

Beta-testers (thank you!) should add:

      (load "/j/office/app/emacs/dev/jane-elisp/elisp/jane/jane-defaults")

or:

      (load "/j/office/app/emacs/dev/jane-elisp/elisp/jane/jane-common")

These are analogous to the above, but with the next release.

** At home

For use at home:
  - Choose a site-lisp directory S.
  - Clone the BitBucket repo into S/jane.
  - Add one of the following to .emacs:

      (load "S/jane/elisp/jane/jane-defaults")
      (load "S/jane/elisp/jane/jane-common")

[You will also need to build omake_server.exe to use Omake.compile.]

* Development

** At the office

To build omake_server.exe:

    hg clone https://bitbucket.org/seanmcl/ocaml-core-external
    cd ocaml-core-external
    hg clone ssh://hg2//hg/jane-elisp/test # this directory
    cd test
    PATH=/janelibs/ocaml-4.00.1+jane1+with-fp/bin:$PATH
    omake

You can clone ocaml-core-external with ssh://hg@bitbucket.org rather
than https://bitbucket.org after you create an account and Sean gives
you access to his repo.  See
https://confluence.atlassian.com/display/BITBUCKET/Using+the+SSH+protocol+with+bitbucket
about setting up keys.

** Opam release

Our repo for opam is  https://seanmcl@bitbucket.org/seanmcl/omake-mode.

Workflow:
- Work on omake-mode in https://seanmcl@bitbucket.org/seanmcl/js-elisp.
- When we're ready for a major release, copy from there to https://seanmcl@bitbucket.org/seanmcl/omake-mode.
- Create a new version in opam-repository/packages/omake-mode.N.N in our fork of opam-repository
  https://github.com/seanmcl/opam-repository.git
- Issue a pull request to ocamlpro
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.