From acb0d0759d8ceaefc1f058538b8a459266c89020 Mon Sep 17 00:00:00 2001
From: Paul Swartz <paul@paulswartz.net>
Date: Wed, 6 Nov 2024 16:12:06 -0500
Subject: [PATCH] doc: cleanup README

- fix typos
- remove comments from command lines
---
 README.md | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index f864f2e..524789f 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,10 @@
 
 A set of scripts for working with TransitMaster. Reference the rating process documentation [here](https://github.com/mbta/wiki/blob/master/transit_tech/Procedures/TransitMaster/TM-03_Make_Updates.md).
 
-**Effect:**	Different steps throughout the rating process. Allows data validation before importing into TransitMaster.
-**Circumstances:**	As needed. Generally once per quarterly rating.
-**Required Skills:**	None
-**Required Tools:**	VPN access, a text editor, access to TM databases
+**Effect:** Different steps throughout the rating process. Allows data validation before importing into TransitMaster.
+**Circumstances:** As needed. Generally once per quarterly rating.
+**Required Skills:** None
+**Required Tools:** VPN access, Git, a text editor, access to TM databases
 
 ## Setup
 
@@ -17,7 +17,7 @@ $ brew install freetds gdal uv
 $ uv python install
 $ uv sync
 $ cp .env.template .env
-$ vi .env  # configure environment variable
+$ vi .env
 ```
 
 ### Windows
@@ -27,7 +27,7 @@ $ set Path=C:\Users\%USERNAME%\.cargo\bin;%Path%
 $ uv python install
 $ uv sync
 $ copy .env.template .env
-$ wordpad .env  # configure environment variable
+$ notepad .env
 ```
 
 ## HASTUS sync
@@ -39,9 +39,11 @@ Sync a HASTUS export to the TransitMaster server, validating the data in the pro
   variable. If you have trouble logging in, set `USERNAME` to your AD account.
 
 ```
-$ uv run python -m registered.hastus_sync # (if testing, use "—no-push" to avoid actually updating the rating data on the TM server)
+$ uv run python -m registered.hastus_sync
 ```
 
+If you're testing, add `--no-push` to avoid actually updating the rating data on the TM server.
+
 ## Scripts
 
 For the scripts below, you will have to access the rating folder on <TRANSITMASTER_FILE_SERVER> on your local machine to direct it to the right path. If you're working from a PC computer, you are all set. If you're working from a MAC, follow the instructions below.