This repository has been archived by the owner on Aug 9, 2023. It is now read-only.
Improvements to the help menu (+colours) #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
.gitignore now has .idea stuff and Rust stuff. cargo.toml now has the colored package for command line colours. the LICENSE has been updated
Now it looks like: ----------------------------- ReCTx Project Manager v1.0.0 ----------------------------- Usage: rectx <command> [Commands] Help : rectx help : Shows this help message. New : rectx new : Creates a new ReCTx project. Build : rectx build : Builds the current ReCTx project. Run : rectx run : Runs the current ReCTx project. For more information check out the GitHub page: https://github.com/hrszpuk/rectx or join the ReCT Discord server: https://discord.gg/Ymm9xGxWZf
All help menus now have colour. All commands now have their own help menu: rectx help help rectx help run rectx help build rectx help create|new Create is now a valid alias for new. There are now commands to help generate the help menus, this is to reduce duplicate code.
I've added a help module and renamed some public help module functions to better organise code.
hrszpuk
added
documentation
Closed
hrszpuk
commented
Sep 24, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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