From 21ea67a55d0f6d5e9c68332ef7e3f43a893d7ac7 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 3 Feb 2015 00:50:52 -0800 Subject: [PATCH] [DOC] README and LICENSE updates --- LICENSE | 5 ++--- README.md | 22 +++++++++++++++++++++- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/LICENSE b/LICENSE index 1c1a3e6de6..6608f2341a 100644 --- a/LICENSE +++ b/LICENSE @@ -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: diff --git a/README.md b/README.md index 8990ea0595..e15ddfc56f 100644 --- a/README.md +++ b/README.md @@ -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) +