Skip to content

Commit 487c77a

Browse files
committed
Update README
1 parent a9a0ade commit 487c77a

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

tooling/codelab_rebuild/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,33 @@ At the top level, the `codelab_rebuild.yaml` configuration file contains
3030
two keys, `name` for the name of the script, and `steps` which is the collection
3131
of steps required to rebuild the codelab.
3232

33-
Individual steps can have a variety of attributes, which control what the step
34-
does. All steps must have a `name` which is output during the run. This is
33+
Individual steps can have a variety of attributes, which control what the step
34+
does. All steps must have a `name` which is output during the run. This is
3535
primarily for debugging a script when things break.
3636

37-
Steps may have a `steps` for a list of sub steps, in which case it can't have
37+
Steps may have a `steps` for a list of sub steps, in which case it can't have
3838
any other attributes. Steps within steps can go as deep as required.
3939

40-
For removing a file there is `rm`, removing a directory `rmdir`, creating a
40+
For removing a file there is `rm`, removing a directory `rmdir`, creating a
4141
directory there is `mkdir`, each of which takes as the value the path to the
4242
file or directory to create or remove.
4343

44-
For modifying the content of files there are two approaches. For replacing the
45-
contents of a file, there is `replace-contents` key which takes the new contents of
44+
For modifying the content of files there are two approaches. For replacing the
45+
contents of a file, there is `replace-contents` key which takes the new contents of
4646
the file as the value. Note, if the file doesn't exist, `replace-contents` will \
47-
create the file. To specify the file to be modified you must also set the
47+
create the file. To specify the file to be modified you must also set the
4848
`path` key with the relative path to the file.
4949

50-
Alternatively there is the `patch` family of keys, which are fed to the `patch`
51-
command to update the file nominated by the `path` key. After much trial and
50+
Alternatively there is the `patch` family of keys, which are fed to the `patch`
51+
command to update the file nominated by the `path` key. After much trial and
5252
error I have stabilised on using `patch-u` (unified diffs), generated with the
5353
help of the `git diff` command.
5454

5555
For running `flutter` and `dart` commands there are appropriate keys. Use the
5656
`path` key to nominate the working directory in which to run the `flutter` or
5757
`dart` command.
5858

59-
There is a `platforms` key to restrict which platforms a step will be run on.
59+
There is a `platforms` key to restrict which platforms a step will be run on.
6060
This is useful for specifying that specific `flutter` commands are only run
61-
on platforms that support that form of executable. No point trying to build
62-
an iOS Flutter app on MS Windows.
61+
on platforms that support that form of executable. No point trying to build
62+
an iOS Flutter app on MS Windows.

0 commit comments

Comments
 (0)