The original help menu (the help menu that is currently used in the master branch as of the time of this commit) is rather ugly and does not help the user understand what each command does.
Original help menu for reference:
ReCTx :: Help Menu
Usage: rectx <command> [options]
Commands:
help -> shows this menu
new [name] -> creates a new project
run -> runs the current project
build -> builds the current project
For more information visit the GitHub page: https://github.com/hrszpuk/rectx
The brief description given for each command is very basic, in fact, you gather about has much information from the command name itself as the description give you (e.g. "run" obviously runs the project code). Furthermore, the information is not coloured whatsoever which can make it head to read, and hard to pick out important information.
In the original help menu, only one command has a more detail explanation...
Original help menu for the new command:
ReCTx :: Help Menu :: "new"
Usage: rectx new project-name
This command will create a new ReCT project with the name provided.
The project will contain: /src/main.rs, README.md, and config.toml!
For more information visit the GitHub page: https://github.com/hrszpuk/rectx
The information is still brief and does not highlight the important information. The information in this help menu is also outdated. Other commands such as 'build' and 'run' do not have their own help menu which, despite not the commands name being self-explanatory, leaves more specific information about the commands (such as configuration with config.toml) unknown to the user.
The new help menu
The new help menu aims to use colours to highlight more important information, and provide a way for users to see more information about a command.
The help command (rectx help) can now accept a <command> argument for the command the user wishes to understand more. Examples: rectx help newrectx help buildrectx help run
Improvements made
Issues with the original help menu
The original help menu (the help menu that is currently used in the
masterbranch as of the time of this commit) is rather ugly and does not help the user understand what each command does.Original help menu for reference:
The brief description given for each command is very basic, in fact, you gather about has much information from the command name itself as the description give you (e.g. "run" obviously runs the project code). Furthermore, the information is not coloured whatsoever which can make it head to read, and hard to pick out important information.
In the original help menu, only one command has a more detail explanation...
Original help menu for the new command:
The information is still brief and does not highlight the important information. The information in this help menu is also outdated. Other commands such as 'build' and 'run' do not have their own help menu which, despite not the commands name being self-explanatory, leaves more specific information about the commands (such as configuration with
config.toml) unknown to the user.The new help menu
The new help menu aims to use colours to highlight more important information, and provide a way for users to see more information about a command.
The help command (
rectx help) can now accept a<command>argument for the command the user wishes to understand more. Examples:rectx help newrectx help buildrectx help run