https://github.com/shaps80/appledoc

A handy script for managing appledoc installation and generation.
https://github.com/shaps80/appledoc

Last synced: about 1 year ago
JSON representation

A handy script for managing appledoc installation and generation.

• Host: GitHub
• URL: https://github.com/shaps80/appledoc
• Owner: shaps80
• Created: 2013-05-09T22:49:14.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2013-05-09T23:13:12.000Z (about 13 years ago)
• Last Synced: 2025-02-28T22:41:39.097Z (over 1 year ago)
• Language: Shell
• Size: 211 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
appledoc

========

I use appledoc a lot for generating my documentation but one thing that's annoyed me for a while is the installation and usage of this great utility from the command line.

I sometimes have to setup a new computer and wanted a handy script that I could just install and have it do all the heavy lifting, forcing my devs to work the same way as the rest of the team. This has been especially useful when dealing with contractors.

adgen currently supports the following features:

* Downloads, compiles and installs appledoc when required.

  * -u forces a fresh installation of appledoc, overwriting existing version

* GIT style config files are stored per directory 

* Simple text file for .adconfig allowing easy editing

  * -p prints current config

  * -r runs config again

* Auto install to Xcode

  * -x to disable

* Displays full details about each step, paths, etc...

* Colors indicate important information, warnings or errors

* If you're using GIT, auto-add (optional) GIT tracking to generated documentation and config

* Confirmation for config, you can bail if its incorrect

* Auto discovery and feedback about Xcode projects found and GIT status

* Auto backup (optional) existing documentation folder

* Auto generation of documentation, keeping intermediate files where specified in config

* Auto generate config file on first run/per directory

* Built in Help system with more information and options 'adgen -h'

Future Plans

------------

* Menu based system

* Silent auto-generation every nth second

Installation

------------

I've provided the actual script however the easiest way to install is by downloading the adgen-installer and running it. 

Once you've done that just run 'adgen' from the folder where your Xcode project files exist and the script will take of the rest.

To install manually you'll need to chmod 700 (executable) adgen.sh and copy it to /bin/local/bin/adgen