mirror of
https://github.com/go-task/task.git
synced 2025-01-26 05:27:15 +02:00
Fix README typos
This commit is contained in:
parent
576b18246a
commit
2e1d0ab4a6
10
README.md
10
README.md
@ -8,7 +8,7 @@ It aims to be simpler and easier to use then [GNU Make][make].
|
||||
|
||||
## Installation
|
||||
|
||||
If you have a Go environment setup, you can simply run:
|
||||
If you have a [Go][golang] environment setup, you can simply run:
|
||||
|
||||
```bash
|
||||
go get -u -v github.com/go-task/task/cmd/task
|
||||
@ -20,7 +20,8 @@ Or you can download from the [releases][releases] page and add to your `PATH`.
|
||||
|
||||
Create a file called `Taskfile.yml` in the root of the project.
|
||||
(`Taskfile.toml` and `Taskfile.json` are also supported, but YAML is used in
|
||||
the documentation). The `cmds` key should contains the commands of a task:
|
||||
the documentation). The `cmds` attribute should contains the commands of a
|
||||
task:
|
||||
|
||||
```yml
|
||||
build:
|
||||
@ -57,7 +58,7 @@ js:
|
||||
### Task dependencies
|
||||
|
||||
You may have tasks that depends on others. Just pointing them on `deps` will
|
||||
run them automatically:
|
||||
make them run automatically before running the parent task:
|
||||
|
||||
```yml
|
||||
build:
|
||||
@ -104,7 +105,7 @@ Will stop at the moment the dependencies of `task2` are executed.
|
||||
### Prevent task from running when not necessary
|
||||
|
||||
If a task generates something, you can inform Task the source and generated
|
||||
files, to Task will prevent to run them if not necessary.
|
||||
files, so Task will prevent to run them if not necessary.
|
||||
|
||||
```yml
|
||||
build:
|
||||
@ -139,3 +140,4 @@ up-to-date.
|
||||
|
||||
[make]: https://www.gnu.org/software/make/
|
||||
[releases]: https://github.com/go-task/task/releases
|
||||
[golang]: https://golang.org/
|
||||
|
Loading…
x
Reference in New Issue
Block a user