Permalink
Browse files

Updated readme file; finally added --no boolean switch description (p…

…lus some minor reorganization).
  • Loading branch information...
1 parent fa77f08 commit db9b19798043f2001a5acbbc41f64de87c47ed06 @tomaz committed Sep 11, 2009
Showing with 9 additions and 1 deletion.
  1. +9 −1 Readme.markdown
View
@@ -82,12 +82,17 @@ you can also use "Install" script from the Xcode - just select "Install" as the
target and build it. It will install all required files to the application support
directory (you still need to manually copy the executable).
-Now you're ready to go! You can periodically check for updates by typing the following
+Now you're ready to go! Build the project to generate the `appledoc` executable. I recommend
+you copy the executable to some directory on your path such as `/usr/local/bin` or similar so
+that it is easily accessible. You can periodically check for updates by typing the following
into your terminal:
cd <directory where you installed appledoc>
git pull
+If you're using precompiled executable, the installation is similar. Just copy the files to
+the locations as mentioned above.
+
Quick start / tutorial
----------------------
@@ -154,6 +159,9 @@ command line, the spaces are automatically escaped for you, at least for paths,
may not be necessary, however if you're using it as Xcode build script, you need to take
care of that!
+Oh, and all boolean swithces can be prefixed with `--no-` following the switch name to
+override the default or global value. Example: `--no-docset`.
+
That being said, the usage is:
appledoc [options]

0 comments on commit db9b197

Please sign in to comment.