Skip to content

Commit

Permalink
Remove installation instructions from the README and point to the Use…
Browse files Browse the repository at this point in the history
…r Guide (#30)
  • Loading branch information
booniepepper authored Jul 15, 2023
1 parent 5064a03 commit 22b3902
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
# `dt`

It's duct tape for your unix pipes. A programming language for doing small
stuff fast and easy.
stuff fast, easy, and readable.

In the words of [Red Green](https://www.redgreen.com):

> Remember, it's only temporary... unless it works!
Note: [The dt User Guide](https://dt.plumbing/user-guide/) exists but is still
in progress. Basic usage is shown in the instructions below.


## Use in pipes

When piping in/out, the REPL is skipped. If something is piping into `dt` then
Expand Down Expand Up @@ -102,18 +106,11 @@ Now, this is only temporary... unless it works.
The above example assumes a bash-like shell. Details on the syntax and
configuration files to set an alias that persists will vary by your shell.

## Downloads

Download assets from [releases](https://github.com/booniepepper/dt/releases/) and
put them somewhere on your PATH.

An installation script may come soon.
## Installing

## Building from source
* https://dt.plumbing/user-guide/tutorial/install.html

To build from source, clone the repo and run `./build help` for instructions.
The project currently builds with Zig 0.11.+.
The resulting binary for your machine will be produced as `./zig-out/bin/dt`.

## The nerdy stuff

Expand Down

0 comments on commit 22b3902

Please sign in to comment.