> For the complete documentation index, see [llms.txt](https://asrob-uc3m.gitbook.io/robotdevastation-user-manual/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://asrob-uc3m.gitbook.io/robotdevastation-user-manual/master.md).

# README

[![Robot Devastation Logo](/files/-LCibnuANv7k-xYOBNPq)](http://asrob-uc3m.github.io/workgroups/2017-05-28-robot-devastation.html)

## Robot Devastation User Manual

[Robot Devastation](http://asrob-uc3m.github.io/workgroups/2017-05-28-robot-devastation.html) User Manual

Currently hosted at <https://asrob-uc3m.gitbooks.io/robotDevastation-user-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](https://github.com/asrob-uc3m/robotDevastation-user-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-user-manual/issues/new).

### How-To's

* [How to serve on localhost](/robotdevastation-user-manual/master.md#how-to-serve-on-localhost)
* [How to upload changes to GitHub](/robotdevastation-user-manual/master.md#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-user-manual/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.