commit 77e4b75db74ae8f848212fef818ec564d09a2c15
author Marc Khouri <mnck@google.com> Fri Dec 02 18:12:58 2022 +0000
committer CQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com> Fri Dec 02 18:12:58 2022 +0000
tree 5cbf1a615ce2cd93cb14a7e14299170960101cc2
parent 61c0d80dedb6cfede2b2202ef04cba534843c063

Tweak README

Adds comments about venv commands, and uses
a separate directory for config files (for users who
end up with many).

Change-Id: I297c2962a648908b81a6696eff816a96eeba3879
Reviewed-on: https://fuchsia-review.googlesource.com/c/antlion/+/769629
Reviewed-by: Sam Balana <sbalana@google.com>
Fuchsia-Auto-Submit: Marc Khouri <mnck@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>

.gitignore

diff --git a/.gitignore b/.gitignore
index c3e857d..029341d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -81,6 +81,7 @@
 # antlion configuration files
 /*.json
 /*.yaml
+/config/
 
 # antlion runtime files
 /logs

README.md

diff --git a/README.md b/README.md
index f7d055a..cb10088 100644
--- a/README.md
+++ b/README.md
@@ -21,25 +21,27 @@
    git clone https://fuchsia.googlesource.com/antlion
    ```
 
-2. Install dependencies
+2. Install dependencies using [venv](https://docs.python.org/3/library/venv.html#how-venvs-work)
 
    ```sh
    cd antlion
-   python3 -m venv .venv
-   source .venv/bin/activate
-   pip install --editable .[dev,test]
+   python3 -m venv .venv  # creates a "virtual environment" in the `.venv` directory
+   source .venv/bin/activate  # activates the virtual environment. Run `deactivate` to exit it later
+   pip install --editable ".[dev,test]"
    ```
 
 3. Write the sample config and update the Fuchsia controller to match your
    development environment
 
    ```sh
-   cat <<EOF > config.json
+   mkdir -p config
+   cat <<EOF > config/simple.json
    {
       "testbed": [{
          "name": "simple_testbed",
          "FuchsiaDevice": [{
             "ip": "fuchsia-00e0-4c01-04df",
+            "ssh_priv_key": "/home/fuchsia/.ssh/fuchsia_ed25519",
             "ssh_config": "/home/fuchsia/out/default/ssh-keys/ssh_config",
             "ffx_binary_path": "/home/fuchsia/out/default/host_x64/ffx"
          }]
@@ -53,7 +55,7 @@
 4. Run the sanity test
 
    ```sh
-   antlion -c config.json -tc Sl4fSanityTest
+   antlion -c config/simple.json -tc Sl4fSanityTest
    ```
 
 See `antlion -h` for more full usage.