Skip to content

Commit

Permalink
better README
Browse files Browse the repository at this point in the history
  • Loading branch information
sgruhier committed May 2, 2008
1 parent b62be6a commit 01a47a5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.markdown
Expand Up @@ -22,7 +22,7 @@ Currently, documentation is based on NaturalDocs. To generate hmtl files just tu

> rake doc
## Help
## Help Wanted

We want to move to [PDoc](http://pdoc.org/) and we need help to write new documentation.
Nothing has been done yet, only rake tasks.
Expand All @@ -39,7 +39,7 @@ then you can generate pdoc files
And open pdoc/index.html to check it. Pretty easy.

To avoid conflicts with current doc, do not includ pdoc comment in current JS file. Edit documentation.pdoc in each component directory.
To avoid conflicts with current doc, do not includ pdoc comment in current JS file. Edit documentation.pdoc in each component directory (add any new .pdoc file, they will be used in rake pdoc).
When you're done, pull request :).

Thanks in advance for your help.
Expand Down

0 comments on commit 01a47a5

Please sign in to comment.