You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by pi...@apache.org on 2019/05/15 16:45:41 UTC
[royale-docs] branch master updated: Further improve build
instructions
This is an automated email from the ASF dual-hosted git repository.
piotrz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 7cab225 Further improve build instructions
new ce65726 Merge pull request #20 from Aszusz/bugfix/correct-build-instructions
7cab225 is described below
commit 7cab22550615262cc769cdcc0cbbca7239a7966f
Author: Adrian Szuszkiewicz <ad...@gmail.com>
AuthorDate: Wed May 15 16:36:40 2019 +0200
Further improve build instructions
---
README.md | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 8b0ad8a..13bd945 100644
--- a/README.md
+++ b/README.md
@@ -56,12 +56,15 @@ You can also use straight HTML for these links, like this:
1. Install [Ruby+Devkit](https://rubyinstaller.org/downloads/). Ruby is required to run Jekyll.
2. Install [Jekyll](https://jekyllrb.com/)
-3. In the `royale-docs` project copy `_config.yml` to `local_config.yml`
-4. In `local_config.yml` change `baseurl` parameter to `../`
-5. Run the following command:
+3. If you want to provide a local configuration copy `_config.yml` to `local_config.yml`
+4. To build the docs run the following command:
```sh
jekyll build --config local_config.yml
```
-
-6. The website is rendered inside the `_site` folder
\ No newline at end of file
+ The website will be rendered inside the `_site` folder.
+5. To browse the docs using built-in Jekyll server run the following command:
+ ```sh
+ jekyll serve
+ ```
+ The website will be availeble at `http://127.0.0.1:4000/royale-docs/`
\ No newline at end of file