[forge-dev] On README.asciidoc

[Lincoln Baxter, III]

Hey Ivan,

Sorry for the late reply.

We have a template you should use for your README.asciidoc. It's located
here:
https://raw.github.com/forge/core/2.0/addons/impl/src/main/resources/org/jboss/forge/addon/addons/README.asciidoc

For the commands, you should add Man pages (we have not yet documented
this):
https://github.com/forge/core/blob/2.0/shell/impl/src/main/resources/org/jboss/forge/addon/shell/commands/ExitCommand.txt

You'll just need to place the .txt or .ad or .asciidoc file in the
resources source directory with the same package and name as the command it
documents. E.g: The above text file will display when you type "man exit",
for this:
https://github.com/forge/core/blob/2.0/shell/impl/src/main/java/org/jboss/forge/addon/shell/commands/ExitCommand.java

Also, to get the current resource, you need to get the initial selection:

https://github.com/forge/core/blob/2.0/projects/api/src/main/java/org/jboss/forge/addon/projects/ui/AbstractProjectCommand.java#L58

Does this answer your questions?

Cheers!
~Lincoln

-- 
Lincoln Baxter, III
http://ocpsoft.org
"Simpler is better."
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/forge-dev/attachments/20131119/7f704615/attachment.html