Permalink
Browse files

Add notes for generating documentation locally

  • Loading branch information...
1 parent e836941 commit 849cc3c86bb625c4bab34f8ce8b55e37f48ce0cd @semperos committed Feb 14, 2012
Showing with 5 additions and 3 deletions.
  1. +5 −3 README.md
View
@@ -1,12 +1,10 @@
# Clojure API for Selenium-WebDriver #
-This is a Clojure library for driving a web browser using Selenium-WebDriver as the backend. For more comprehensive documentation on all of clj-webdriver's features, read the [Github wiki](https://github.com/semperos/clj-webdriver/wiki). You can generate documentation locally with `lein doc`.
+This is a Clojure library for driving a web browser using Selenium-WebDriver as the backend. For more comprehensive documentation on all of clj-webdriver's features, read the [Github wiki](https://github.com/semperos/clj-webdriver/wiki). You can generate documentation locally with `lein doc` (API docs) or `lein marg` (annotated source).
**clj-webdriver Resources**
* [Project Wiki](https://github.com/semperos/clj-webdriver/wiki)
- * [API Documentation](http://techylinguist.com/static/clj-webdriver/index.html)
- * [Marginalia Documentation (v0.5.0-SNAPSHOT)](http://techylinguist.com/static/clj-webdriver/uberdoc.html)
* [Google Group](https://groups.google.com/forum/#!forum/clj-webdriver)
* [Issue Queue](https://github.com/semperos/clj-webdriver/issues)
@@ -201,6 +199,10 @@ From a "user" perspective, working with Selenium-WebDriver's Grid 2 support beha
For information about configuring your Grid hub and nodes (which is handled at the command-line using the server-standalone jars), read [the Selenium-WebDriver wiki documentation on Grid 2](http://code.google.com/p/selenium/wiki/Grid2).
+## Documentation ##
+
+For reference documentation, run `lein doc` at the root of this repo. For annotated source documentation, run `lein marg`.
+
## Contributing ##
The `master` branch of clj-webdriver houses code intended for the next **minor-version release.** If you want to propose new features for the next release, you're welcome to fork, make a topic branch and issue a pull request against the `master` branch.

0 comments on commit 849cc3c

Please sign in to comment.