Skip to content

Commit 878de3c

Browse files
DavidSouthercpyle0819
authored andcommitted
Update README.md
1 parent c9f155c commit 878de3c

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

.tools/readmes/README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,7 @@ This is an internal tool intended for use only by the AWS code examples team.
99

1010
## Prerequisites
1111

12-
You must have a recent version of Python installed to run this tool,
13-
and a recent version of pip (Python's package manager) to install the
14-
required packages.
15-
16-
### Install packages
17-
18-
We recommend a virtual environment. Create a virtual environment
19-
and install packages by running the following commands in the
20-
`.tools/readmes` folder:
12+
We recommend a virtual environment to run this tool.
2113

2214
```
2315
cd .tools/readmes
@@ -36,12 +28,14 @@ the commands might vary slightly. For example, on Windows, use `py` in place of
3628

3729
## Generate a README
3830

31+
> These instructions assume you're running the commands from the `.tools/writeme`
32+
> directory, using the venv installed there.
33+
3934
WRITEME creates content primarily from metadata you have already
4035
authored for the SOS project. After you have authored metadata and snippet tags
4136
for your examples, run the following command in the root folder of the repo:
4237

4338
```
44-
cd .tools/readmes # (if not already in the readme directory)
4539
python -m writeme --languages <language>:<version> --services <service>
4640
```
4741

0 commit comments

Comments
 (0)