Permalink
Browse files

Add some markdown.

  • Loading branch information...
skeeto committed Jan 12, 2013
1 parent 89a8164 commit 231173fcb7845f549b17fcfcbefa85e7a70ce604
Showing with 11 additions and 5 deletions.
  1. +11 −5 README.md
View
@@ -1,11 +1,17 @@
+# Emacs Java Support
+
See the header comments in each file for full documentation. The
recommended usage is in java-mode-plus.el.
To install drop these in your load-path somewhere and require them
(after enabling ido-mode, if you use ido-mode),
- (require 'java-mode-plus)
- (require 'java-docs)
+```el
+(require 'java-mode-plus)
+(require 'java-docs)
+```
+
+## Depreciation
**NOTICE**: The java-docs portion of this package is depreciated. It
has been replaced by the more powerful
@@ -15,9 +21,9 @@ instead.
To use java-docs you'll need to tell it where to find some
documentation. For example,
- (java-docs "/usr/share/doc/openjdk-6-jdk/api")
-
-Then use C-h j to look something up.
+```el
+(java-docs "/usr/share/doc/openjdk-6-jdk/api")
+```
The snippets directory contains some YASnippets that hook into
java-docs class completing reads.

0 comments on commit 231173f

Please sign in to comment.