mirror/cadmus
1
0
Fork 0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-01-18 05:09:05 +01:00
Code Issues Releases Wiki Activity

Rewrote README

Browse Source
This commit is contained in:
Ryan Greenup 2020-07-17 04:34:39 +10:00
parent e3053afc6d
commit c032922d58
1 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -8,26 +8,19 @@ this is an attempt to wrap them into a single script and then have aliases to ma
![](./MainMenu.png) ![](./MainMenu.png)
The idea is that it is just a menu to dispatch different scripts so I could
share those scripts with classmates.
## Philosophy ## Design Philosophy
- ****<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 - ****<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 - the script name ~~will~~ should always be printed to the terminal so the individual
script can be used for whatever purpose. script can be repurposed with out fishing through code.
- SubFunctions will take *only one* argument or `STDIN` - Subscripts ~~will~~ should take *only one* argument (or `STDIN`)
- If the first argument is either `-h` or `--help` help will be printed and then `exit 0` - 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. - This might lead to some limitations but the simplicity is for sanity, modularity and extensibility.
- Will always return absolute path. - Will always return absolute path.
- I played around with relative path but it got confusing when calling the script from inside a function inside a script, so instead if you want a relative path you should do `scriptname './' | xargs realpath --relative-to='./'` - I played around with relative path but it got confusing when calling the script from inside a function inside a script, so instead if you want a relative path you should do `scriptname './' | xargs realpath --relative-to='./'`
- ****<span style="color:rgb(90,210,90);font-family:Courier New,Courier, monospace,serif;">cadmus</span>**** will take the notes directory from the global variable `CADMUS_NOTES_DIR`
- The Actual work will be done by subscripts denoted by `description.bash`
- The subscripts will take the note directory as an argument so they are portable and modular
- The Arguments will be shifted and then all passed down to subfunctions
- I'll just need to be careful that loose arguments aren't dangerous
- Be a Front end to tie together different scripts and tools - Be a Front end to tie together different scripts and tools
- Don't replicate work other people have done. - Don't replicate work other people have done.
- Plain Text, Open Source. - Plain Text, Open Source.
@ -35,6 +28,10 @@ this is an attempt to wrap them into a single script and then have aliases to ma
- Pipe in input, output goes to STDOUT - Pipe in input, output goes to STDOUT
- Leave Aliases and piping to the user - Leave Aliases and piping to the user
- See [Recommended Aliases](#recommended-aliases) - See [Recommended Aliases](#recommended-aliases)
- ****<span style="color:rgb(90,210,90);font-family:Courier New,Courier, monospace,serif;">cadmus</span>**** will take the notes directory from the global variable `CADMUS_NOTES_DIR`
- The Actual work will be done by subscripts denoted by `description.bash`
- The subscripts will take the note directory as an argument so they are portable and modular
- The Arguments will be shifted and then all passed down to subfunctions
## Installation ## Installation