Fixed README

This commit is contained in:
Lian Drake 2024-06-15 21:21:55 -04:00
parent e5a7b72537
commit c1d82d156d

View file

@ -18,9 +18,9 @@
This tool is provided as source code and can be built using `make`. By just This tool is provided as source code and can be built using `make`. By just
typing make in the terminal within the code's directory: typing make in the terminal within the code's directory:
```bash ```bash
make make
``` ```
You should now have an executable named `ascii-dencoder`. Optionally, you can You should now have an executable named `ascii-dencoder`. Optionally, you can
copy it to a location in your PATH for easier access. copy it to a location in your PATH for easier access.
@ -30,9 +30,9 @@ copy it to a location in your PATH for easier access.
To use `ascii-dencoder`, run the executable from the command line with the To use `ascii-dencoder`, run the executable from the command line with the
appropriate options. appropriate options.
```bash ```bash
./ascii-dencoder [OPTIONS] <value> ./ascii-dencoder [OPTIONS] <value>
``` ```
## Options ## Options
@ -54,44 +54,44 @@ appropriate options.
1. Convert a string to ASCII codes: 1. Convert a string to ASCII codes:
```bash ```bash
./ascii-dencoder -s "hello" ./ascii-dencoder -s "hello"
``` ```
Output: Output:
``` ```
The ASCII code of the character 'h' is 104 The ASCII code of the character 'h' is 104
The ASCII code of the character 'e' is 101 The ASCII code of the character 'e' is 101
The ASCII code of the character 'l' is 108 The ASCII code of the character 'l' is 108
The ASCII code of the character 'l' is 108 The ASCII code of the character 'l' is 108
The ASCII code of the character 'o' is 111 The ASCII code of the character 'o' is 111
``` ```
2. Convert an ASCII code to a character: 2. Convert an ASCII code to a character:
```bash ```bash
./ascii-dencoder -c 104 ./ascii-dencoder -c 104
``` ```
Output: Output:
``` ```
The ASCII character for code '104' is 'h' The ASCII character for code '104' is 'h'
``` ```
3. Display help message: 3. Display help message:
```bash ```bash
./ascii-dencoder -h ./ascii-dencoder -h
``` ```
This will display detailed usage instructions and available options. This will display detailed usage instructions and available options.
4. Display version: 4. Display version:
```bash ```bash
./ascii-dencoder -v ./ascii-dencoder -v
``` ```
This will show the current version of the program. This will show the current version of the program.