Skip to content

Commit b77fcd6

Browse files
committed
Documentation improvements
1 parent b5b2649 commit b77fcd6

File tree

3 files changed

+60
-22
lines changed

3 files changed

+60
-22
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
[![Build Status](https://travis-ci.org/go-task/task.svg?branch=master)](https://travis-ci.org/go-task/task)
22

3-
# Task - A task runner / simpler Make alternative written in Go
3+
# Task
44

5-
Task is a simple tool that allows you to easily run development and build
6-
tasks. Task is written in Go, but can be used to develop any language.
7-
It aims to be simpler and easier to use then [GNU Make][make].
5+
Task is a task runner / build tool that aims to be simpler and easier to use
6+
than, for example, [GNU Make][make].
87

98
---
109

docs/README.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,46 @@
11
# Task
22

3-
A task runner / simpler Make alternative written in Go
3+
Task is a task runner / build tool that aims to be simpler and easier to use
4+
than, for example, [GNU Make][make].
45

5-
Task is a simple tool that allows you to easily run development and build
6-
tasks. Task is written in Go, but can be used to develop any language.
7-
It aims to be simpler and easier to use then [GNU Make][make].
6+
Since it's written in [Go][go], Task is just a single binary and has no other
7+
dependencies, which means you don't need to mess with any complicated install
8+
setups just to use a build tool.
9+
10+
Once [installed](installation), you just need to describe your build tasks
11+
using a simple [YAML][yaml] schema in a file called `Taskfile.yml`:
12+
13+
```yaml
14+
version: '2'
15+
16+
tasks:
17+
hello:
18+
cmds:
19+
- echo 'Hello World from Task!'
20+
silent: true
21+
```
22+
23+
And call it by running `task hello` from you terminal.
24+
25+
The above example is just the start, you can take a look at the [usage](usage)
26+
guide to check the full schema documentation and Task features.
27+
28+
## Features
29+
30+
- [Easy installation](installation): just download a single binary, add to
31+
$PATH and you're done! Or you can also install using [Homebrew][homebrew] or
32+
[Snapcraft][snapcraft] if you want;
33+
- Available on CIs: by adding [this simple command](installation#install-script)
34+
to install on your CI script and you're done to use Task as part of your CI pipeline;
35+
- Truly cross-platform: while most build tools only work well on Linux or macOS,
36+
Task also supports Windows thanks to [this awesome shell interpreter for Go][sh];
37+
- Great for code generation: you can easily [prevent a task from running](usage#prevent-unnecessary-work)
38+
if a given set of files haven't changed since last run (based either on its
39+
timestamp or content).
840

941
[make]: https://www.gnu.org/software/make/
42+
[go]: https://golang.org/
43+
[yaml]: http://yaml.org/
44+
[homebrew]: https://brew.sh/
45+
[snapcraft]: https://snapcraft.io/
46+
[sh]: https://mvdan.cc/sh

docs/installation.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Installation
22

3-
## Go
4-
5-
If you have a [Golang][golang] environment setup, you can simply run:
3+
## Binary
64

7-
```bash
8-
go get -u -v github.com/go-task/task/cmd/task
9-
```
5+
Or you can download the binary from the [releases][releases] page and add to
6+
your $PATH. DEB and RPM packages are also available.
7+
The `task_checksums.txt` file contains the sha256 checksum for each file.
108

119
## Homebrew
1210

@@ -27,23 +25,27 @@ right:
2725
sudo snap install task
2826
```
2927

28+
## Go
29+
30+
If you have a [Go][go] environment setup, you can simply run:
31+
32+
```bash
33+
go get -u -v github.com/go-task/task/cmd/task
34+
```
35+
3036
## Install script
3137

3238
We also have a [install script][installscript], which is very useful on
33-
scanarios like CIs. Many thanks to [godownloader][godownloader] for easily
34-
generating this script.
39+
scanarios like CIs. Many thanks to [godownloader][godownloader] for allowing
40+
easily generating this script.
3541

3642
```bash
3743
curl -s https://taskfile.org/install.sh | sh
3844
```
3945

40-
## Binary
41-
42-
Or you can download the binary from the [releases][releases] page and add to
43-
your `PATH`. DEB and RPM packages are also available.
44-
The `task_checksums.txt` file contains the sha256 checksum for each file.
46+
> This method will download the binary on the local `./bin` directory by default.
4547
46-
[golang]: https://golang.org/
48+
[go]: https://golang.org/
4749
[snapcraft]: https://snapcraft.io/
4850
[homebrew]: https://brew.sh/
4951
[installscript]: https://github.com/go-task/task/blob/master/install-task.sh

0 commit comments

Comments
 (0)