Skip to content

Commit c9f155c

Browse files
DavidSouthercpyle0819
authored andcommitted
Update tools README.md to streamline things that are handled by update.py
1 parent 3f4a530 commit c9f155c

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

.tools/readmes/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,14 @@ and install packages by running the following commands in the
2020
`.tools/readmes` folder:
2121

2222
```
23+
cd .tools/readmes
2324
python -m venv .venv
24-
.venv\Scripts\activate # Windows
25-
source .venv/bin/activate # *nix
26-
python -m pip install -r requirements.txt
25+
26+
# Windows
27+
.venv\Scripts\activate
28+
29+
# Linux or MacOS
30+
source .venv/bin/activate
2731
```
2832

2933
Depending on how you have Python installed and on your operating system,
@@ -37,7 +41,8 @@ authored for the SOS project. After you have authored metadata and snippet tags
3741
for your examples, run the following command in the root folder of the repo:
3842

3943
```
40-
python .tools/readmes/writeme.py --languages <language>:<version> --services <service>
44+
cd .tools/readmes # (if not already in the readme directory)
45+
python -m writeme --languages <language>:<version> --services <service>
4146
```
4247

4348
WRITEME reads metadata and config data and generates READMEs in the service
@@ -46,7 +51,7 @@ folder for the specified languages, versions, and services.
4651
For example, to generate an S3 README for Python:
4752

4853
```
49-
python .tools/readmes/writeme.py --languages Python:3 --services s3
54+
python -m writeme --languages Python:3 --services s3
5055
```
5156

5257
This creates a README.md file in the `python/example_code/s3` folder.
@@ -65,7 +70,7 @@ This creates a README.md file in the `python/example_code/s3` folder.
6570
You can get inline usage info by using the `-h` flag:
6671

6772
```
68-
python .tools/readmes/writeme.py -h
73+
python -m writeme -h
6974
```
7075

7176
### Configuration
@@ -129,7 +134,7 @@ This creates the README.md files in `python/example_code/s3` and other folders.
129134
To build all READMEs for Rust:
130135

131136
```
132-
$ python .tools/readmes/writeme.py --languages Rust:1
137+
$ python -m writeme --languages Rust:1
133138
INFO:root:Dry run, no changes will be made.
134139
DEBUG:root:Rendering Rust:1:acm
135140
DEBUG:root:Rendering Rust:1:api-gateway
@@ -146,5 +151,5 @@ and complete folder override as the value. See dotnetv3 for an example.
146151
And yes, building all readmes for all languages after changing metadata or templates is now as easy as
147152

148153
```
149-
python .tools/readmes/writeme.py
154+
python -m writeme
150155
```

0 commit comments

Comments
 (0)