Permalink
Browse files

Update usage of CONVERT-FROM-DOCUMENT-FILE

Add descriptions for :markdown.
  • Loading branch information...
1 parent 5b36a37 commit c8f461e0d1e7d0e1c77bee23f76cd3e60aa8fcf1 @ichimal committed Sep 21, 2012
Showing with 5 additions and 3 deletions.
  1. +5 −3 README.md
View
@@ -11,11 +11,13 @@ Read a document file (included in source tree of your project) into a string.
e.g. `(convert-from-document-file "readme.txt" :systemname)`
-* You can specify file type with `:type` keyword to convert file format *(future work)*
+You can specify file type with `:type` keyword to convert file format.
- Default file type is `:plain-text`.
+Supported file types are `:plain-text` (this is default) and `:markdown`.
- e.g. `(convert-from-document-file "readme.md" :systemname :type :markdown)`
+e.g. `(convert-from-document-file "readme.md" :systemname :type :markdown)`
+
+*Note:* `:markdown` is not supported on GNU CLISP environment because of troubles of CL-MARKDOWN package.
### *[Macro]* `update-long-description`:

0 comments on commit c8f461e

Please sign in to comment.