Repository: incubator-crail Updated Branches: refs/heads/master 995fda86c -> 8734cf309
[Documentation] include doc generation in README Include description how to generate documentation in README. Signed-off-by: Jonas Pfefferle <peppe...@apache.org> Project: http://git-wip-us.apache.org/repos/asf/incubator-crail/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-crail/commit/ec2fe149 Tree: http://git-wip-us.apache.org/repos/asf/incubator-crail/tree/ec2fe149 Diff: http://git-wip-us.apache.org/repos/asf/incubator-crail/diff/ec2fe149 Branch: refs/heads/master Commit: ec2fe1499bcb7d170aa58b6318b41755fb4dd4eb Parents: 995fda8 Author: Jonas Pfefferle <peppe...@apache.org> Authored: Mon Nov 5 14:40:24 2018 +0100 Committer: Jonas Pfefferle <peppe...@apache.org> Committed: Mon Nov 5 14:40:52 2018 +0100 ---------------------------------------------------------------------- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-crail/blob/ec2fe149/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 32976a7..5a5db9d 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Crail is implemented in Java offering a Java API which integrates directly with ## Documentation -Please check out the [documentation](https://incubator-crail.readthedocs.org) for information about how to deploy, run, test and program against Crail. +The documentation can be accessed by running `make html` in `/doc` and opening `/doc/build/html/index.html` for information about how to deploy, run, test and program against Crail. The latest version of the documentation can be found at https://incubator-crail.readthedocs.org. ## Community @@ -53,4 +53,4 @@ Apache Crail is an effort undergoing incubation at The Apache Software Foundatio Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, -it does indicate that the project has yet to be fully endorsed by the ASF. \ No newline at end of file +it does indicate that the project has yet to be fully endorsed by the ASF.
