Skip to content

Commit 6da22c3

Browse files
committed
dev: init
1 parent dd0b712 commit 6da22c3

File tree

1 file changed

+34
-25
lines changed

1 file changed

+34
-25
lines changed

README.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1717
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
18+
1819
**Table of Contents**
1920

2021
- [Description](#description)
@@ -56,31 +57,6 @@ Qt6 C++23 shell/commandline application to encrypt / decrypt the given file.
5657

5758
See folder `docs/img` for screenshots.
5859

59-
## Test / Performance
60-
61-
**tested on**
62-
63-
- x86_64 Ubuntu 24.04.2 LTS
64-
- Intel(R) Core(TM) i5-9600K CPU @ 3.70GHz with 6 cpu cores
65-
- average SSD storage
66-
- fallocate -l 1G test.img
67-
68-
**read / write binary mode of 1 GB file with a chunk size of 4 MB**
69-
| type | val |
70-
| ---- | --------- |
71-
| real | 5m52,734s |
72-
| user | 5m49,905s |
73-
| sys | 0m2,391s |
74-
75-
**read / write binary mode of 1 GB file with a chunk size of 16 MB**
76-
| type | val |
77-
| ---- | --------- |
78-
| real | 5m50,753s |
79-
| user | 5m48,691s |
80-
| sys | 0m2,049s |
81-
82-
=> so compiled chunk size is 4 MB to give better feedback about the process status.
83-
8460
## Features
8561

8662
- [ ] i18n
@@ -120,11 +96,40 @@ See folder `docs/img` for screenshots.
12096

12197
## Encryption
12298

99+
_under construction_
100+
123101
> \[!WARNING]
124102
> don't loose your password. Decryption/Recovery without valid password is impossible!
125103
126104
## Decryption
127105

106+
_under construction_
107+
108+
## Test / Performance
109+
110+
**tested on**
111+
112+
- x86_64 Ubuntu 24.04.2 LTS
113+
- Intel(R) Core(TM) i5-9600K CPU @ 3.70GHz with 6 cpu cores
114+
- average SSD storage
115+
- fallocate -l 1G test.img
116+
117+
**read / write binary mode of 1 GB file with a chunk size of 4 MB**
118+
| type | val |
119+
| ---- | --------- |
120+
| real | 5m52,734s |
121+
| user | 5m49,905s |
122+
| sys | 0m2,391s |
123+
124+
**read / write binary mode of 1 GB file with a chunk size of 16 MB**
125+
| type | val |
126+
| ---- | --------- |
127+
| real | 5m50,753s |
128+
| user | 5m48,691s |
129+
| sys | 0m2,049s |
130+
131+
=> so compiled chunk size is 4 MB to give better feedback about the process status.
132+
128133
<p align="right">(<a href="#top">back to top</a>)</p>
129134

130135
# Installation
@@ -142,6 +147,8 @@ See folder `docs/img` for screenshots.
142147

143148
## Windows
144149

150+
_under construction_
151+
145152
# Development
146153

147154
## Dependencies
@@ -178,6 +185,7 @@ Small and portable AES encryption class for Qt. Native support for all key sizes
178185
## folder structure
179186

180187
<!-- readme-tree start -->
188+
181189
```
182190
.
183191
├── .github
@@ -223,6 +231,7 @@ Small and portable AES encryption class for Qt. Native support for all key sizes
223231
224232
9 directories, 32 files
225233
```
234+
226235
<!-- readme-tree end -->
227236

228237
<p align="right">(<a href="#top">back to top</a>)</p>

0 commit comments

Comments
 (0)