ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-04 11:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] README and LICENSE updates

Browse Source
This commit is contained in:
mDuo13
2015-02-03 00:50:52 -08:00
parent 539d23bfce
commit 21ea67a55d
2 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
LICENSE
View File

@@ -2,10 +2,9 @@ The Ripple Dev Portal and all its original contents are provided under the MIT L
The MIT License (MIT)
Ripple Dev Portal Copyright (c) 2014 Ripple Labs, Inc.
Ripple Dev Portal Copyright (c) 2014, 2015 Ripple Labs, Inc.
Flatdoc Copyright (c) 2013, 2014, Rico Sta. Cruz.
jQuery Copyright (c) 2005, 2014 jQuery Foundation and other contributors,
https://jquery.org/
jQuery Copyright (c) 2005, 2014 jQuery Foundation and other contributors, https://jquery.org/
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

22
README.md
View File

@@ -3,4 +3,24 @@ ripple-dev-portal
The [Ripple Developer Portal](https://dev.ripple.com) is the authoritative source for Ripple documentation, including the `rippled` server, Ripple-REST API, Gatewayd, and other Ripple software.
Please contribute pull requests to the **gh-pages** branch with any improvements or revisions.
Repository Layout
-----------------
The pages in this portal are generated from the markdown files in the [content/](content/) folder.
You can run your own local copy of the Dev Portal by hosting it in a web server, such as Apache. By default, the Dev Portal uses static HTML pages and client-side JavaScript (specifically, [Flatdoc](http://ricostacruz.com/flatdoc/)) to parse and display the Markdown content on the fly.
The [tool/](tool/) folder contains tools and templates for generating the HTML files in the top level. The `parse_pages.py` script (Python 3 and [Jinja 2](http://jinja.pocoo.org/) required) uses the templates and the [pages.json](tools/pages.json) file to generate all the HTML files on the top level. Files with "md" properties are considered documentation pages and appear in the appropriate lists. There are two modes for generating pages:
* The default, dynamic pages. Generates thin HTML wrappers for each page and uses Flatdoc to load and parse the contents. Great for development since a refresh automatically picks up changes to the md files.
* Pre-compiled pages. Requires [Pandoc](http://johnmacfarlane.net/pandoc/). Parses the Markdown all at once and puts the contents directly into the HTML body of each file. Still experimental.
Contributing
------------
The Developer Portal welcomes outside contributions, especially to the documentation contents. If you have any corrections, improvements, or expansions of the portal, please contribute pull requests to the **gh-pages** branch.
Contributions become copyright Ripple Labs and are provided under the MIT [LICENSE](LICENSE)