denis/sf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
Denis Lehmann 2022-01-10 00:54:35 +01:00
parent 16d569bd86
commit cc835f9310
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.org
View file

@ -35,7 +35,7 @@
*** 1. /sf/-variables *** 1. /sf/-variables
This is the list of variables which can be set *before* including /sf/. This is the list of variables which can be set *before* including /sf/.
Every variable is optional. Everything is optional.
| Name | Description | Example | | Name | Description | Example |
|--------------+-----------------------------------------------------------------------------------------------------+--------------------------------------| |--------------+-----------------------------------------------------------------------------------------------------+--------------------------------------|
@ -93,7 +93,7 @@
If you declared for example a flag like this: If you declared for example a flag like this:
#+begin_src sh #+begin_src sh
sfargs+=("verbose:v:Enable verbose output") sfargs+=("verbose;v;Enable verbose output")
#+end_src #+end_src
Then the variable =$verbose= exists with a value of either =false= or =true=. Then the variable =$verbose= exists with a value of either =false= or =true=.
@ -125,13 +125,13 @@
#+begin_example #+begin_example
Please enter your name [John]: Jane Please enter your name [John]: Jane
Hello Jane! Hello Jane!
Do you want to proceed? [Y/n] Do you want to proceed? [Y/n]
Are you sure? [y/N] y Are you sure? [y/N] y
Please continue... Please continue...
#+end_example #+end_example
*Note* the colon and the question marks are added by the functions. *Note* that the colon and question marks get added by the functions.
**** Output functions **** Output functions
Two output functions are provided which can be used to throw warnings and errors. Two output functions are provided which can be used to throw warnings and errors.