Skip to content

Commit 163fdeb

Browse files
committed
Updating README.
1 parent 8a5f3d8 commit 163fdeb

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,36 @@ One of the primary ideas behind Decode was enabling the layering of multiple dif
55

66
Uses [Qt6](https://www.qt.io), and [QHotkey](https://github.com/Hellmark/QHotkey), set up to be built using [CMake](https://www.cmake.org)
77

8+
## How to use
9+
10+
### GUI
11+
12+
Decode's basic operation is pretty simple. If you're using the Qt based GUI, it opens up like a text editor, and you can then place the text that you want to encode or decode into the text field, and then select the operation to perform. One of the big concepts is the ability to perform multiple operations on a given text to increase difficulty for unintended parties to find the real meaning.
13+
14+
If you're going to use the RSA encoding, it makes use of GPG private and public pem key files. Public to encode, and private to decode. You can save a default key in settings and when performing an RSA action, select a different key if desired or remain with the default.
15+
16+
### Commandline
17+
18+
Decode's base operations are also include for use from a CLI. Make use of the following flags when using at the commandline
19+
20+
- **-i** or **--input**
21+
- specify the path of the file used for input
22+
23+
- **-o** or **--output** (optional)
24+
- specify the path of the file used for output. If none are specified, it will output to stdout.
25+
26+
- **-f** or **--function**
27+
- specify whether to **encode** or **decode**
28+
29+
- **-c** or **--codec**
30+
- declare which codec to use. Available options are base64, rot13, caesar, binary, hex, piglatin, atbash, morse, aes, rsa
31+
32+
- **-k** or **--key** (only for AES or RSA codecs)
33+
- state the key to be used for encoding or decoding. For AES, this is a text string like a password. For RSA, this would be the path for the gpg key file.
34+
35+
- **-h** or **--help**
36+
- this will state the basic CLI options for assistance.
37+
838
## How to build
939

1040
Included is a .pro file for use for building using Qt Creator / qmake, and a CMakeLists.txt file for use with CMake.

main.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ QString useCodec(const QString &inputFile, const QString &outputFile,
9595
void printUsage() {
9696
QTextStream out(stdout);
9797
out << "Usage:\n"
98-
<< " decode -i <input_file> -o <output_file> -f <encode|decode> -c <codec>\n\n"
99-
<< "Available codecs: base64, rot13, caesar, binary, hex, piglatin, atbash, morse, aes\n";
98+
<< " decode -i <input_file> -o <output_file> -f <encode|decode> -c <codec>\n\n -k <key>"
99+
<< "Available codecs: base64, rot13, caesar, binary, hex, piglatin, atbash, morse, aes, rsa\n";
100100
}
101101

102102
int main(int argc, char *argv[]) {

0 commit comments

Comments
 (0)