From e31108c9c71a1ef06f929cc919675446dc685719 Mon Sep 17 00:00:00 2001 From: Sven SAULEAU Date: Sat, 3 Feb 2018 18:54:58 +0100 Subject: [PATCH 1/2] feat: add doc --- content/guides/agent-training/index.md | 10 ++++++++++ content/guides/bytearena-cli/index.md | 2 +- content/guides/getting-started/index.md | 14 +++++++++++--- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/content/guides/agent-training/index.md b/content/guides/agent-training/index.md index d311dd2..838e634 100644 --- a/content/guides/agent-training/index.md +++ b/content/guides/agent-training/index.md @@ -28,3 +28,13 @@ Over 60 tps the visualization might not be as fluid anymore. The alternative is ### Use the file recorder Currently in development. + +## Automatically rebuild and restart + +You can run the following command to start the watcher: + +```sh +ba train --watch path/to/your/agent +``` + +That will automatically rebuild and restart your agent when a change is detected. diff --git a/content/guides/bytearena-cli/index.md b/content/guides/bytearena-cli/index.md index 68ccad8..41164fe 100644 --- a/content/guides/bytearena-cli/index.md +++ b/content/guides/bytearena-cli/index.md @@ -27,4 +27,4 @@ Please refer to the [Building the agent](/guides/getting-started/#building-the-a ## Scaffolding -Please refer to the [Building the agent](/guides/getting-started/#scaffolding-the-source-code-of-an-agent). +Please refer to the [Scaffolding the source code of an agent](/guides/getting-started/#scaffolding-the-source-code-of-an-agent). diff --git a/content/guides/getting-started/index.md b/content/guides/getting-started/index.md index 890056d..cea7999 100644 --- a/content/guides/getting-started/index.md +++ b/content/guides/getting-started/index.md @@ -48,9 +48,7 @@ Building an agent means producing a runnable Docker image with the agent code. As we have seen in the previous example, the scaffolding operation has already built the agent for us. -Note: if you want to modify the id (`powerful-jennet` here for example) of your agent, the steps are explained in the [agent-configuration guide](guides/agent-configuration/). - -## Recommended way +Note: if you want to modify the id (`powerful-jennet` here for example) of your agent, the steps are explained in the [agent-configuration guide](/guides/agent-configuration/). If you want to rebuild it though, you need to issue this command: @@ -343,3 +341,13 @@ const steering = new Vector2(-0.5, 0); This concludes the Byte Arena "Getting Started" guide. From there you can proceed to the ["Basic obstacle avoidance" guide](/guides/basic-obstacle-avoidance) to learn how to make your way around obstacles in the world. + +## Automatically rebuild and restart + +You can run the following command to start the watcher: + +```sh +ba train --watch path/to/your/agent +``` + +That will automatically rebuild and restart your agent when a change is detected. From dc896520ca5d6a795b07a8866150c8743e573bf5 Mon Sep 17 00:00:00 2001 From: Sven SAULEAU Date: Sat, 3 Feb 2018 18:59:07 +0100 Subject: [PATCH 2/2] feat: add watcher build --- content/guides/getting-started/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/guides/getting-started/index.md b/content/guides/getting-started/index.md index cea7999..fb23baf 100644 --- a/content/guides/getting-started/index.md +++ b/content/guides/getting-started/index.md @@ -62,6 +62,8 @@ You can also skip the path altogether in the command if you are in the root fold $ ba build ``` +Note: you can also pass `--watch` to the previous command to automatically rebuild when a file changed. + # Giving it a ride The agent you just built is already able to fly!