Marown/SWADroid
Marown/SWADroid
1
1
Fork 0
Code Issues 25 Pull Requests Packages Projects Releases 28 Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Juan Miguel Boyero Corral 2010-11-01 11:06:16 +01:00
parent 3beb8e9c07
commit 40167dafc3
1 changed files with 19 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -8,73 +8,28 @@ Content
-------
SWADroid/ Android client.
/LICENSE License file.
/libs Libraries required by SWADroid.
/res Resources required by SWADroid.
/src Source files.
Webservices/ Webservices implemented in SWAD server.
COPYING License file.
HISTORY.md Changelog file.
README.md This file.
/LICENSE License file.
HISTORY.md Changelog file in GitHub markdown format.
README.md This file in GitHub markdown format.
Installation
-----------
Copyright and License
---------------------
gem install github-markup
Copyright (C) 2010, Juan Miguel Boyero Corral
SWADroid client is free software; you can redistribute it and/or modify
it under the same terms as [GPLv3][gplv3] license.
SWADroid Webservices is free software; you can redistribute it and/or modify
it under the same terms as [AGPLv3][agplv3] license.
Usage
-----
require 'github/markup'
GitHub::Markup.render('README.markdown', "* One\n* Two")
Or, more realistically:
require 'github/markup'
GitHub::Markup.render(file, File.read(file))
Testing
-------
To run the tests:
$ rake
To add tests see the `Commands` section earlier in this
README.
Contributing
------------
1. Fork it.
2. Create a branch (`git checkout -b my_markup`)
3. Commit your changes (`git commit -am "Added Snarkdown"`)
4. Push to the branch (`git push origin my_markup`)
5. Create an [Issue][1] with a link to your branch
6. Enjoy a refreshing Diet Coke and wait
License
--------
SWADroid client is published under GPLv3 license.
Webservices are published ander AGPLv3 license.
Contact
--------
Juan Miguel Boyero Corral
### Email
juanmi1982@gmail.com
###Twitter
@louisverona
[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13
[1]: http://github.com/github/markup/issues
[issues]: http://github.com/github/markup/issues
[gplv3]: http://www.gnu.org/licenses/gpl.html
[agplv3]: http://www.gnu.org/licenses/agpl.html