You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ratis.apache.org by el...@apache.org on 2017/12/01 12:02:56 UTC
incubator-ratis git commit: RATIS-5. udpated readme
Repository: incubator-ratis
Updated Branches:
refs/heads/RATIS-5 aaa973ced -> 3913b9ea1
RATIS-5. udpated readme
Project: http://git-wip-us.apache.org/repos/asf/incubator-ratis/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ratis/commit/3913b9ea
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ratis/tree/3913b9ea
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ratis/diff/3913b9ea
Branch: refs/heads/RATIS-5
Commit: 3913b9ea176790fcad3bd083d1ff9edcb16e72ef
Parents: aaa973c
Author: Márton Elek <el...@apache.org>
Authored: Fri Dec 1 13:03:10 2017 +0100
Committer: Márton Elek <el...@apache.org>
Committed: Fri Dec 1 13:03:10 2017 +0100
----------------------------------------------------------------------
README.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/3913b9ea/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4719a17..308d009 100644
--- a/README.md
+++ b/README.md
@@ -12,14 +12,22 @@
limitations under the License. See accompanying LICENSE file.
-->
+# Apache Ratis web page
+This is the source code of the website of Apache Ratis.
+To render it you need hugo static site generator (https://gohugo.io/getting-started/installing) which is available for the most popular platforms as a single binary.
-## Check the site
+To render the final website use the following command:
+```
+hugo -d /destination/dir
+```
-## Development
+To develop the site use
```
hugo serve
```
+
+which starts an internal server where you can always check the final rendered version.