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-15 11:10:09 +01:00
parent 587b9ac114
commit 0213c21749
1 changed files with 3 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.org
View file

@ -85,16 +85,12 @@
There are three methods of including /sf/: There are three methods of including /sf/:
1. Grab the /sf/ file from this repo, place it next to your script and source it: 1. Grab the /sf/ file from this repo, place it next to your script and source it:
#+begin_src sh : source "$(dirname $0)/sf"
source "$(dirname $0)/sf"
#+end_src
2. Copy and paste the *oneliner* from the top of this README 2. Copy and paste the *oneliner* from the top of this README
3. Source /sf/ from the web with =curl=: 3. Source /sf/ from the web with =curl=:
#+begin_src sh : source <(curl -s https://raw.githubusercontent.com/Deleh/sf/master/sf)
source <(curl -s https://raw.githubusercontent.com/Deleh/sf/master/sf)
#+end_src
*Note* that this adds an online dependency to your script and if /sf/ changes your script may break. *Note* that this adds an online dependency to your script and if /sf/ changes your script may break.
This method should only be used for testing purposes. This method should only be used for testing purposes.
@ -107,9 +103,7 @@
The values are stored in variables with the name =$<name>=. The values are stored in variables with the name =$<name>=.
If you declared for example a flag like this: If you declared for example a flag like this:
#+begin_src sh : sfargs+=("verbose;v;Enable verbose output")
sfargs+=("verbose;v;Enable verbose output")
#+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=.