summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Unterwaditzer <markus@unterwaditzer.net>2014-11-14 12:55:29 +0100
committerMarkus Unterwaditzer <markus@unterwaditzer.net>2014-11-14 12:55:29 +0100
commit1421515faa029db9cfa32902ae739024a5e3a0c4 (patch)
treee7035c2a6e1fc29213c4a5087353b4fcfd8fbc00
parent7fc2d49204f25c8e4daee57514d64a4f3e415ca0 (diff)
Add online docs
-rw-r--r--Makefile6
-rw-r--r--README.md4
2 files changed, 10 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 8d322a6..04a7d1c 100644
--- a/Makefile
+++ b/Makefile
@@ -19,3 +19,9 @@ clean:
cd "$(THIS_DIR)"
mv code.bak src/vobject/lib.rs || true
rm *.bak || true
+
+upload:
+ cd "$(THIS_DIR)"
+ echo '<!doctype html><title>rust-vobject</title><meta http-equiv="refresh" content="0; ./vobject/">' \
+ > ./target/doc/index.htm
+ rsync -avze ssh ./target/doc/ untispace:~/virtual/rust-vobject.unterwaditzer.net/
diff --git a/README.md b/README.md
index 99f5b83..24aaa69 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,10 @@ based on [rust-peg](https://github.com/kevinmehall/rust-peg).
## Documentation
+The API documentation is [online
+available](http://rust-vobject.unterwaditzer.net), or you can build it
+yourself:
+
make docs
## Testsuite