Commits

Peter Szilagyi committed 77cf341

Moved omake_server.exe build instructions into the repo and updated.

  • Participants
  • Parent commits cd6f980

Comments (0)

Files changed (1)

--*- mode: org -*-
+-*- org -*-
 
-Jane Street Emacs utilities.
+Jane Street Emacs utilities
 
 * Usage
 
 
 Everyone should add one of the following lines to their .emacs file.
 
-*** (load "/j/office/app/emacs/prod/jane-elisp/elisp/jane/jane-defaults")
+    (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.
 
-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")
-
-Only loads libraries and sets variables according to our coding
-standards.  Discretionary settings are left to the user.
+    (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
+Beta-testers (thank you!) should add:
 
       (load "/j/office/app/emacs/dev/jane-elisp/elisp/jane/jane-defaults")
 
-or
+or:
 
       (load "/j/office/app/emacs/dev/jane-elisp/elisp/jane/jane-common")
 
 
 ** At home
 
-For use 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
-
+  - 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
+
+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
+    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.