This is an automated email from the ASF dual-hosted git repository.
janardhan pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/systemml.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 82d73bd [MINOR][DOC] Readme install guide for Ubuntu
82d73bd is described below
commit 82d73bd8c715a3c8e436543a6c6d5db14cb9b1bb
Author: Sebastian <[email protected]>
AuthorDate: Wed Apr 8 20:56:52 2020 +0200
[MINOR][DOC] Readme install guide for Ubuntu
- This installation method tested on Ubutnu and WSL on Windows
- User install is recommended instead of root with `~/.bashrc`
Closes #882.
---
README.md | 51 +++++++++++++++++++++++++++++++++++++--------------
1 file changed, 37 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 5a4b175..4fbdb5f 100644
--- a/README.md
+++ b/README.md
@@ -17,26 +17,49 @@ limitations under the License.
{% endcomment %}
-->
-# Apache SystemML Documentation
+# Apache SystemDS Documentation
-The primary SystemML documentation is written in markdown (*.md) and can be
converted to HTML using
+The primary SystemDS documentation is written in markdown (*.md) and can be
converted to HTML using
[Jekyll](http://jekyllrb.com).
-Jekyll (and optionally Pygments) can be installed on the Mac OS in the
following manner.
+## Ubuntu Install
+
+1. Install Ruby development environment [Jekyll on
Ubuntu](https://jekyllrb.com/docs/installation/ubuntu/).
+2. Install Jekyll inside the Ruby environment.
+
+ - `gem install jekyll jekyll-redirect-from bundler pygments.rb`
+ - To do this you might need to change permissions on folders
`/var/lib/gems` and `/var/lib/gems/2.5.0`.
+ - The Pygments package is optional, and does require sudo permissions.
+
+3. Install python dependencies (Optionally).
+
+ - `pip install Pygments`
- $ brew install ruby
- $ gem install jekyll
- $ gem install jekyll-redirect-from
- $ gem install bundler
- $ brew install python
- $ pip install Pygments
- $ gem install pygments.rb
+4. Launch the Documentation locally
+
+ - `jekyll serve -w`
+ - This is done from the root of the gh-pages branch of the system.
+ - The serving will per default be on localhost port 4000
[Link](http://localhost:4000)
+
+## Mac Install
+
+Jekyll (and optionally Pygments) can be installed on the Mac OS in the
following manner.
-For installation on other platforms, please consult the Jekyll documentation.
+```bash
+brew install ruby
+gem install jekyll
+gem install jekyll-redirect-from
+gem install bundler
+brew install python
+pip install Pygments
+gem install pygments.rb
+```
-To generate SystemML documentation in HTML, navigate to the ```docs``` folder,
the root directory of the
+To generate SystemDS documentation in HTML, navigate to the ```docs``` folder,
the root directory of the
documentation. From there, you can have Jekyll convert the markdown files to
HTML. If you run in server mode,
-Jekyll will serve up the generated documentation by default at
http://127.0.0.1:4000. Modifications
+Jekyll will serve up the generated documentation by default at
<http://127.0.0.1:4000>. Modifications
to *.md files will be converted to HTML and can be viewed in a web browser.
- $ jekyll serve -w
+```bash
+jekyll serve -w
+```
