mirror/cadmus
1
0
Fork 0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-08-30 17:19:47 +02:00
Code Issues Releases Wiki Activity

Restructured Subfunctions to be simpler

Browse Source
This commit is contained in:
ryangreenup
2020-07-14 21:23:47 +10:00
parent f6e8e1c190
commit 85db26cfff
3 changed files with 82 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -11,16 +11,12 @@ this is an attempt to wrap them into a single script and then have aliases to ma
## Philosophy
- cadmus acts as a menu for scripts to acheive things
- ****<span style="color:rgb(90,210,90);font-family:Courier New,Courier, monospace,serif;">cadmus</span>**** acts as a menu for scripts to acheive things
- the script name will always be printed to the terminal so the individual
script can be used for whatever purpose.
- SubFunctions will take only two arguments:
- `-h` or `--help` as a help function
- If this is seen anywhere the help will be printed and the script exit will.
- Some type of input:
- `-d` or `--dir` as a directory location
- `-p` or `--path` as a file location
- `STDIN` which is piped into the subfunction.
- SubFunctions will take *only one* argument or `STDIN`
- If the first argument is either `-h` or `--help` help will be printed and then `exit 0`
- This might lead to some limitations but the simplicity is for sanity, modularity and extensibility.