From e582bcdfb6e9cc5e5af1bfb722caf5e785ab9479 Mon Sep 17 00:00:00 2001
From: Jussi Kukkonen <jkukkonen@google.com>
Date: Tue, 5 Sep 2023 13:08:24 +0300
Subject: [PATCH] Update DEVELOPMENT.md

* Add some details hat make it more likely for the commands to succeed
* Remove duplicated information
---
 docs/DEVELOPMENT.md | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
index 56f25738..2ac68642 100644
--- a/docs/DEVELOPMENT.md
+++ b/docs/DEVELOPMENT.md
@@ -3,7 +3,10 @@
 A development install can be made in any environment but venv is recommended:
 
 ```shell
-# Create environment
+# Clone the project
+git clone https://github.com/theupdateframework/tuf-on-ci.git
+cd tuf-on-ci
+# Create virtual environment
 python3 -m venv .venv
 # Enter environment
 source .venv/bin/activate
@@ -36,27 +39,22 @@ manually after inspection and it will work as if the push was done by the tool i
 
 ### Debugging repository tools
 
-The same tool (`tuf-on-ci-status`) that runs during the automation
-can be run locally too to inspect the current status of the signing
-event branch.
+The same tool (`tuf-on-ci-status`) that runs during the signing event automation
+can be run locally to inspect the current status of the signing event branch. Note
+that the repository tools only operate on current commit (unlike the signing tools 
+that always checkout the remote branch) 
 
-To install the repository tools, run pip install from the
-`repo/` directory where the
-[pyproject.toml](../repo/pyproject.toml) file exists:
-
-```shell
-$ pip install -e .
-```
-
-As an example, this would be the output when an open invitation exists
+As an example, this would be the markdown output when an open invitation exists
 for a new user to become a root key holder:
 
 ```shell
+$ git fetch && git checkout sign/add-fakeuser
+...
 $ tuf-on-ci-status
 ### Current signing event state
-Event [sign/add-fakeuser-1](../compare/sign/add-fakeuser-1)
+Event [sign/add-fakeuser](../compare/sign/add-fakeuser)
 #### :x: root
-root delegations have open invites (@-fakeuser-2).
-Invitees can accept the invitations by running `tuf-on-ci-sign add-fakeuser-2`
+root delegations have open invites (@-fakeuser).
+Invitees can accept the invitations by running `tuf-on-ci-sign sign/add-fakeuser`
 $
 ```