Commits

camlspotter committed 19aceb3

doc update

Comments (0)

Files changed (1)

 with the name of your OCaml compiler version. 
 When you report bugs, please note the revision hash with your issue description please.
 
+Installation and Usage
+============================
+
+To compile OCamlSpotter, just type ``make`` and ``make install``.
+ 
+If you are Emacs user, see ``ocamlspot.el``. It explains how to set up
+and use it:
+
+* Set ``load-path``.
+* Tell Emacs where it can find ``ocamlspot`` binary.
+* Add caml or tuareg mode hook.
+
+If you have done properly, move your cursor to OCaml identifier and
+press ``C-c ;``. Emacs should display the definition of the identifier.
+Otherwise... you made mistake or a bug of OCamlSpotter. Yes, it has bugs.
+
+I have also written Vim script ``ocamlspot.vim``, but it is not tested at all.
+Sorry but I do not use Vim.
+
+
 To work with OCamlSpotter
 ==========================
 
 To browse modules correctly, 
 
-* Compile them with -bin-annot ocaml compiler option.
+* Use the correct ``ocamlspot`` matching with your OCaml compiler version.
+* Set your ``ocamlspot`` binary in your emacs setting (``M-x customize-group => ocamlspot``)
+* See the buffer ``*ocamlspot-process*`` if you thing something goes wrong.
+* Compile OCaml modules with ``-bin-annot`` ocaml compiler option.
 * Keep the source code and produced cmt/cmti files.
 * Install cmt/cmti files along with cmi/cma/cmxa files.
 
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.