camlspotter avatar camlspotter committed 2ae9a4f

document

Comments (0)

Files changed (1)

 OCamlSpotter - OCaml source browsing
 ==========================================
 
-OCamlSpotter is a tool for OCaml source code browsing. You can search the type and definitions of values, expressions and modules.
+OCamlSpotter is a tool for OCaml source code browsing. 
+
+* You can search the definitions of names of values, functions, data types and modules.
+* Emacs and Vim helpers help your browsing via editors.
+* Definition search traverses module aliases and functor applications: if module M = N, OCamlSpotter automatically seeks the definition of M.x in N. Very helpful in the modern OCaml programming with lots of modules.
 
 OCamlSpotter 2.x uses \*.cmt and \*.cmti files created by OCaml compiler 4.00.0 or newer with -bin-annot option.
 
      install::
         cp \*.mli \*.cmi \*.cma \*.cmt \*.cmti \*.cmxa $(INSTALLDIR)
 
-If you want to browse values of OCaml's standard library (stdlib and otherlibs), you must also recompile those modules with -bin-annot option to create cmt/cmti files.
+If you want to browse values of OCaml's standard library (stdlib and otherlibs), 
+you must also recompile those modules with -bin-annot option to create cmt/cmti files.
 
 Some automation
 --------------------------
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.