shenwei356 / rush

A cross-platform command-line tool for executing jobs in parallel
https://github.com/shenwei356/rush
MIT License
846 stars 63 forks source link

Suggestion to improve documentation with practical examples. #40

Closed teebu closed 10 months ago

teebu commented 2 years ago

I just gotta say, this program is pretty cool, but hard to figure out. The documentation does not make it easy. Please include more practical examples, not just echos. Here's something I'm using it for:

Starting two (or more) azure cloudfunctions. run.sh

#!/bin/bash
echo '
    cd operator_a && func start -p 7071; 
    cd service_worker_a && func start -p 7072
    ' \
    | rush --immediate-output -k -T b -D ';'   ' {} '

-D = delimiter (;) -T = trim both sides of input (trying to have a neat script) --immediate-output = only way to get output -k = keep order (probably not important?)

shenwei356 commented 2 years ago

I thought 18 examples are sufficient. :smiling_face_with_tear:

Input can be given either from the STDIN (the echos) or files (-i/--infile); it should be flexible enough.

teebu commented 2 years ago

No that is way too cryptic. Every one of those is very difficult to understand. It took me an hour to understand, and I was about to give up but eventually I stumbled onto a good enough example I can replicate. Took a lot of trial and error to get it going.

shenwei356 commented 10 months ago

The help doc is updated.