Skip to content

Commit 4c68dd1

Browse files
committed
fixed formatting and added content
1 parent 5e110f0 commit 4c68dd1

1 file changed

Lines changed: 12 additions & 14 deletions

File tree

parser/README-ARGBASH.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Building parser.sh
22

3-
43
## About
54

65
parser.sh is the output of [argbash](https://argbash.io) parser generation script.
@@ -11,20 +10,22 @@ parser.sh is the output of [argbash](https://argbash.io) parser generation scrip
1110
2. edit build.sh if you want to add or modify any arguments. This is necessary to build an accurate parser.m4 file.
1211
3. run build
1312

14-
./build.sh NAME_OF_SCRIPT # , e.g.: ./build.sh git-get
13+
./build.sh NAME_OF_SCRIPT # , e.g.: ./build.sh git-get
14+
15+
This will create a new $NAME_OF_SCRIPT.parser.sh and parser.m4.
1516

16-
This will create a new $NAME_OF_SCRIPT.parser.sh and parser.m4.
17+
4. Manually update the parser.tpl file with any changes you might need from the updated parser.m4 file
1718

18-
It doesn't overwrite the real template, parser.tpl, to allow you to manually copy over the sections you need.
19+
The build script doesn't overwrite the real template, parser.tpl, to allow you to manually copy over the sections you need. This is because you'll be making manual changes to the parser.tpl template that aren't possible to script.
1920

20-
On first run, you might copy over the entire template to parser.tpl as a starting point. On each subsequent run, just copy over the parts that have changed (new or modified options)
21+
The first time you run the build script, you'll want to copy over the entire parser.m4 template to parser.tpl as a starting point. On each subsequent run, just copy over the parts that have changed (new or modified options)
2122

22-
1. Once you've modified parser.tpl manually, run ./build.sh a second time. This time your manual changes will be applied to the output.
23-
2. Copy over the git-get-help contents over to to print-help funcajdruff@ajsbox:~/dev/sandbox/argbash$ sudo install argbash-docker argbash-init-docker /usr/bin/tion.
23+
5. Once you've modified parser.tpl manually, run ./build.sh a second time. This time your manual changes will be applied to the output.
24+
6. Copy the contents of `parser/help` over the to print-help function in git-get-parser.sh
2425

2526
## To install Argbash
2627

27-
Install Argbash as a Docker container.ajdruff@ajsbox:~/dev/sandbox/argbash$ sudo install argbash-docker argbash-init-docker /usr/bin/
28+
Take the following steps to install argbash as a Docker container.
2829

2930
Create `argbash-docker`:
3031

@@ -34,13 +35,10 @@ Create `argbash-init`
3435

3536
printf '%s\n' '#!/bin/bash' 'docker run -it -e PROGRAM=argbash-init --rm -v "$(pwd):/work" matejak/argbash "$@"' > argbash-init-docker
3637

37-
Make them executable
38+
Make `argbash-docker` and `argbash-init` executable
3839

3940
chmod a+x argbash-docker argbash-init-docker
4041

41-
Install in your path
42-
43-
sudo install argbash-docker argbash-init-docker /usr/bin/
44-
42+
Install `argbash-docker` and `argbash-init` in your path
4543

46-
# ARG_HELP([Like git clone but without .git],[git get is a git extension that downloads project files without downloading its .git directory])
44+
sudo install argbash-docker argbash-init-docker /usr/bin/

0 commit comments

Comments
 (0)