Skip to content

Commit 81f42c2

Browse files
authored
Update README.md
aligning instructions for running update.py with m-k-manuscript-data instructions
1 parent e2f450e commit 81f42c2

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,17 @@ Note for TXT versions:
2323
# Running update.py
2424
These are detailed instructions for how to use `update.py`. For simpler steps to updating derivatives in `m-k-manuscript-data`, see [the README in that repo](https://github.com/cu-mkp/m-k-manuscript-data/blob/master/README.md).
2525

26-
0. Update `m-k-manuscript-data` with a `git pull`
27-
1. Navigate to your local `manuscript-object` directory.
28-
2. Make sure you're on the correct branch by typing `git status`. If you're not in the correct branch, type `git checkout -b [BRANCH_NAME]`.
29-
3. Run `git pull`.
30-
4. Run update.py. Detailed instructions are below, but specific tasks are listed here:
26+
1. Update `m-k-manuscript-data` master branch:
27+
28+
1. `cd` to `m-k-manuscript-data` directory
29+
2. `git fetch`
30+
3. `git pull` to make sure you are up to date
31+
4. Checkout a branch: `git checkout -b [name of branch]` -- though you will be running code in the `manuscript-object` directory, its output will be written to the `m-k-manuscript-data` directory (i.e., the changes will be made in that directory)
32+
2. Navigate to your local `manuscript-object` directory: `cd` to `manuscript-object` directory
33+
3. Make sure you're on the correct (usually master) branch by typing `git status`. If you're not in the correct branch, type `git checkout -b [BRANCH_NAME]`.
34+
4. `git fetch`
35+
7. `git pull`
36+
6. Run update.py. Detailed instructions are below, but specific tasks are listed here:
3137
- To regenerate all the derivative files from originals: `python3 update.py`
3238
- To test update.py without generating any derivative files: `python3 update.py -d`
3339
- To only generate specific derivatives: `python3 update.py [--all-folios] [--entries] [--metadata] [--txt]`, without the brackets

0 commit comments

Comments
 (0)