Skip to content

Commit

Permalink
Removed development branch description from the readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaz committed Apr 11, 2011
1 parent 1eb294a commit 3f08d5c
Showing 1 changed file with 8 additions and 14 deletions.
22 changes: 8 additions & 14 deletions Readme.markdown
Expand Up @@ -38,33 +38,27 @@ Before running the tool, you need to copy all required template files from Templ
Using appledoc
==============

Use `appledoc --help` to see the list of all command line switches. Read more about appledoc on [appledoc site](http://appledoc.gentlebytes.com) and check short help, documentation and tips on [appledoc's GitHub page](http://tomaz.github.com/appledoc/). Use [appledoc issues page](https://github.com/tomaz/appledoc/issues) to submit bug and feature requests. Before submitting read through open issues to see if the issue is already there and vote on it or add a comment. If you're not using development branch (see installation tips below) also check closed issues as your request may have already been covered but is not yet on master branch!
Use `appledoc --help` to see the list of all command line switches. Read more about appledoc on [appledoc site](http://appledoc.gentlebytes.com) and check short help, documentation and tips on [appledoc's GitHub page](http://tomaz.github.com/appledoc/). Use [appledoc issues page](https://github.com/tomaz/appledoc/issues) to submit bug and feature requests. Before submitting, read through open issues to see if the issue is already there and vote on it or add a comment. You can also check closed issues as your request may have already been covered but the issue remains - feel free to add a comment!

Installation tips
-----------------

To keep up to date, just go to Terminal and cd into appledoc directory, issue `git pull` and recompile appledoc.xcodeproj. Don't forget to overwrite appledoc executable you've copied to $PATH :)

If you've used installation procedure described above in "quick install" section, you're using appledoc on it's master branch. This gives you most stable version available, however it doesn't include all the latest bug fixes and updates. In fact, all of the work on appledoc happens on development branch and is then merged to master branch from time to time. If you'd like to be updated as frequently as possible, you can switch to development branch. We keep this branch very stable too, so you should be fine using it. Switching to development branch only requires one additional step after cloning (this guide includes clone command, if you've already cloned appledoc, skip the first one):

git clone git://github.com/tomaz/appledoc.git
cd appledoc
git checkout --track origin/development

You have now switched to development branch, which you can confirm by running `git branch`. You can update using the same method described above (i.e. `git pull`).

If you also want to compile and run AppledocTests (unit tests) target, you need to copy all the frameworks indicated within Libraries & Frameworks group to shared frameworks directory before building unit tests target! This is not required for building the appledoc tool itself.

Troubleshooting
---------------

Have problems? This is what you can do to troubleshoot:

1. Make sure you have the latest appledoc version, prefferably on development branch. Try `git pull` and run with latest version again. If you're working with master branch, use instructions above to switch to development branch and see if it fixes your issue.
2. Increase verbosity level with `--verbose 3` command line switch. You can progressively increment verbosity up to 6 with each level giving you more detailed information. As this will give you a lot more information, you may want to concentrate only on specific set of source files you have problem with. Note that increasing verbosity will result in slower performance so using levels above 4 for every day use is not recommended.
3. Appledoc is open source project! You have all the source code available, so run it from Xcode. You can setup Xcode to pass the desired command line arguments and add breakpoints to help you isolate your issue. If you feel you'd like to contribute more to community, you are welcome to fork the project on GitHub and add features to it. Keep us posted so we can add these features to main repository as well - include unit tests if possible.
4. If you think you found a bug or want to request new feature, go to [appledoc issues page](https://github.com/tomaz/appledoc/issues). First read existing issues to see if there is already a request there (if you're using master branch, also read closed issues as your request may have already been covered but isn't yet merged on master branch). You can vote on existing requests to help us decide which features to concetrate on or you can add a comment to aid in solving it. If you don't find the request there, create a new issue; include parts of source files that give you problems if possible and/or description or steps that lead to it.
5. If you're having problems with some of your source files and don't want to publish them online, you can contact us through email below. We'll do our best to help you out, but bear in mind appledoc is not commercial product; it's created and maintaned in our spare time, so resources are limited.
1. Make sure you have the latest appledoc version. Try `git pull` and run with latest version again.
2. Make sure you're using the latest templates - copy the files from appledoc project folder to one of the predefined folders (see Quick Install section above).
3. Increase verbosity level with `--verbose` command line switch. Default level is 2, but you can progressively increment verbosity up to 6 with each level giving you more detailed information. As this will give you a lot more information, you may want to concentrate only on specific set of source files you have problem with. Note that increasing verbosity will result in slower performance so using levels above 4 for every day use is not recommended.
4. Appledoc is open source project! You have all the source code available, so run it from Xcode. You can setup Xcode to pass the desired command line arguments and add breakpoints to help you isolate your issue. If you feel you'd like to contribute more to community, you are welcome to fork the project on GitHub and add features to it. Keep us posted so we can add these features to main repository as well - include unit tests if possible.
5. If you think you found a bug or want to request new feature, go to [appledoc issues page](https://github.com/tomaz/appledoc/issues). First read existing issues to see if there is already a request there (if you're using master branch, also read closed issues as your request may have already been covered but isn't yet merged on master branch). You can vote on existing requests to help us decide which features to concetrate on or you can add a comment to aid in solving it. If you don't find the request there, create a new issue; include parts of source files that give you problems if possible and/or description or steps that lead to it.
6. If you're having problems with some of your source files and don't want to publish them online, you can contact us through email below. We'll do our best to help you out, but bear in mind appledoc is not commercial product; it's created and maintaned in our spare time, so resources are limited.


Developer notes
---------------
Expand Down

0 comments on commit 3f08d5c

Please sign in to comment.