Robot Devastation Developer Manual

Robot Devastation Developer Manual

Currently hosted at https://asrob-uc3m.gitbooks.io/robotDevastation-developer-manual/content

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 section (both Open and Closed issues).
2. If your doubt or comment is not a duplicate, please post a detailed New issue.

How-To's

• How to serve on localhost
• 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)-based projects):

   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. You may use Git or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the Gitbook (legacy) mechanism used, and its current settings:

1. Please do not upload the _book/ folder. It is 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.