Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added information about :sources to README

  • Loading branch information...
commit 1fbcaf39da9ca77947024faef2779521c232b88c 1 parent 5160322
@weavejester authored
Showing with 8 additions and 2 deletions.
  1. +8 −2 README.md
View
10 README.md
@@ -2,8 +2,6 @@
A tool for generating documentation from Clojure source code.
-Currently in an early state of development.
-
## Usage
Include the following development dependency in your `project.clj` file:
@@ -15,3 +13,11 @@ Then run:
lein doc
This will generate API documentation in the "doc" subdirectory.
+
+## Options
+
+By default Codox looks for source files in the `src` subdirectory, but
+you can change this by placing the following in your `project.clj`
+file:
+
+ :codox {:sources ["path/to/source"]}
Please sign in to comment.
Something went wrong with that request. Please try again.