Skip to content

Commit

Permalink
doc: cleanup README
Browse files Browse the repository at this point in the history
- fix typos
- remove comments from command lines
  • Loading branch information
paulswartz committed Nov 7, 2024
1 parent cc36a1a commit acb0d07
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit acb0d07

Please sign in to comment.