Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
JarredAllen committed Aug 3, 2019
1 parent 4958c3d commit c682a94
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Ja
A clone of yes from GNU Coreutils, but optionally allowing you to specify a
delay between each time it prints out its argument.

## Installation
#### From source
To build this project from source, download the source via:

```bash
git clone [email protected]:JarredAllen/Ja.git
```

You can then make whatever changes you want to the source, and then build by
running:

```bash
cargo build --release
```

#### From binary
The latest binary executable can be found under the releases tab.

## Usage
`ja "y"`: Prints out y repeatedly (identical to default behavior of yes)

`ja --delay 0.5 "y"`: Prints out y, with a half second delay between each print.

## Contributing
If you have any functionality which you would like to add to this project, fork
it, write your functionality, and then submit a pull request. You should also
run rustfmt on your code before submitting it, and document all functionality in
your code.

## Credits
Originally created by Jarred Allen <[email protected]>.

## Name
The project is named ja, because ja is the german word for yes and because those
are the initials of the original creator of this project.

## License
This project is licensed under the [MIT License](./LICENSE).

0 comments on commit c682a94

Please sign in to comment.