From cd2994b6694486f560312d27b67b902172e325d9 Mon Sep 17 00:00:00 2001 From: jgvictores Date: Sat, 29 Dec 2018 19:54:55 +0100 Subject: [PATCH] README add howto's - https://github.com/asrob-uc3m/robotDevastation/issues/143 - https://github.com/asrob-uc3m/actas/issues/148 --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 924de20..5a63403 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,24 @@ Currently hosted at https://asrob-uc3m.gitbooks.io/robotDevastation-developer-ma ### If you have any doubts or comments 1. Please check if you can find the answer through the corresponding file and/or folder in-source documentation, as well as in the [Issues](https://github.com/asrob-uc3m/robotDevastation-developer-manual/issues) section (both Open and Closed issues). 2. If your doubt or comment is not a duplicate, please post a detailed [New issue](https://github.com/asrob-uc3m/robotDevastation-developer-manual/issues/new). + +### How-To's +* [How to serve on localhost](#how-to-serve-on-localhost) +* [How to upload changes to GitHub](#how-to-upload-changes-to-github) + +## How to serve on localhost +It is useful to serve on `localhost` to modify the website and see changes locally. + +1. From the root of the project, run the following command (which is universal for all [Gitbook (legacy)](https://github.com/GitbookIO/gitbook)-based projects): +```bash +gitbook build && gitbook serve +``` + +2. You can now browse the site at the default location: http://127.0.0.1:4000 + +## How to upload changes to GitHub +This project is managed as any project on [GitHub](https://www.github.com). You may use [Git](https://git-scm.com) or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the [Gitbook (legacy)](https://github.com/asrob-uc3m/actas/issues/148#issuecomment-449748350) mechanism used, and its [current settings](https://github.com/asrob-uc3m/robotDevastation-developer-manual/settings): + +1. Please **do not upload** the `_book/` folder. They are auto-generated locally, and the same should happen on the Gitbook (legacy) servers. + +2. It is safe to `git push` to any upstream branch, just remember that what is on `master` is what will be actually rendered as the website.