Skip to content

Commit 5e1b2d4

Browse files
committed
Eloborative and clear help menu
- added version output support - update usage and instructions for README.md
1 parent be22ebe commit 5e1b2d4

2 files changed

Lines changed: 17 additions & 13 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ _To uninstall the tool from your system execute the following command_
107107

108108
<div align="center">
109109
<a href="https://github.com/proffapt/code-runner">
110-
<img src="images/usage_1_1_3.png" alt="product screenshot">
110+
<img width="1278" alt="image" src="https://user-images.githubusercontent.com/86282911/204351618-f23628c7-83b1-4e44-9463-e89ad91f274e.png">
111111
</a>
112112
</div>
113113

run

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,24 @@ blue=$(tput setaf 4)
2828
cyan=$(tput setaf 6)
2929
white=$(tput setaf 7)
3030

31-
USAGE="${blue}USAGE:${white} run ${cyan}file ${yellow}:${white} compiles and executes the executable
31+
USAGE="${blue}USAGE:${white} run ${yellow}[OPTIONS] ${cyan}file ${yellow}:${white} compiles into an executable, executes it and then deletes it ${yellow}-${white} by default
3232
3333
${blue}OPTIONS: ${white}
34-
[${red}--cc${white}/${red}-c${white}]=${cyan}<compiler>${white} ${yellow}:${white} compiles${red}(${white}NON persistent${red})${white} the *.c file with specified compiler
35-
${red}--cxx${white}=${cyan}<compiler>${white} ${yellow}:${white} compiles${red}(${white}NON persistent${red})${white} the *.cpp file with specified compiler
34+
[${red}--cc${white}/${red}-c${white}]=${cyan}<compiler>${white} ${yellow}:${white} compiles the *.c file with specified compiler
35+
[${red}--cxx${white}]=${cyan}<compiler>${white} ${yellow}:${white} compiles the *.cpp file with specified compiler
3636
[${red}--python${white}/${red}-py${white}]=${cyan}<2/3>${white} ${yellow}:${white} executes the given python file with specified python version
37-
[${red}--debug${white}/${red}d${white}] ${yellow}:${white} compiles${red}(${white}NON persistent${red})${white} the file and pipes it to the specified debugger
38-
[${red}--compile${white}/${red}c${white}] ${yellow}:${white} compiles${red}(${white}persistent${red})${white} the file to an executable but doesn't run it
39-
[${red}--persistent${white}/${red}p${white}] ${yellow}:${white} keeps the intermediate compiled files and cache directories${red}(${white}which are deleted by default${red})${white}
37+
[${red}--debug${white}/${red}d${white}] ${yellow}:${white} compiles the file and pipes it into the default debugger
38+
[${red}--compile${white}/${red}c${white}] ${yellow}:${white} compiles the file to an executable but doesn't execute it ${red}(${white}persistent${red})${white}
39+
[${red}--persistent${white}/${red}p${white}] ${yellow}:${white} keeps the intermediate compiled files and cache directories ${yellow}-${white} which are deleted by default
4040
4141
${blue}Clean Utility:${white}
42-
run ${red}rclean-exe${white} ${yellow}:${white} deletes all executable files within the folder recursively
43-
run ${red}clean-exe${white} ${yellow}:${white} deletes all executable files within the folder NON recursively
44-
run ${red}clean${white} ${yellow}:${white} removes debug folder, .out and temp files
42+
run ${red}rcexe${white} ${yellow}:${white} deletes all executable files within the folder recursively
43+
run ${red}cexe${white} ${yellow}:${white} deletes all executable files within the folder NON recursively
44+
run ${red}clean${white} ${yellow}:${white} removes debug folder, executables and temp files
4545
4646
${blue}Miscellaneous:${white}
47-
run [${red}--list-langs${white}/${red}ll${white}] ${yellow}:${white} lists all languages supported by this code-runner"
47+
run [${red}--list-langs${white}/${red}ll${white}] ${yellow}:${white} lists all languages supported by current version of code-runner
48+
run [${red}--version${white}/${red}v${white}] ${yellow}:${white} echoes the current version of code-runner"
4849

4950
_ERROR_UFTC_() {
5051
echo "${red}ERROR: ${white}This file type can't be compiled or the file does not exist!"
@@ -296,12 +297,15 @@ for arg in "$@"; do
296297
"clean")
297298
clean
298299
;;
299-
"clean-exe")
300+
"cexe")
300301
clean_exe
301302
;;
302-
"rclean-exe")
303+
"rcexe")
303304
rclean_exe
304305
;;
306+
"--version" | "v")
307+
echo "${cyan}code-runner ${white}version : ${yellow}1.1.5${white}"
308+
;;
305309
*)
306310
_ERROR_UFTC_
307311
_EXIT_

0 commit comments

Comments
 (0)