commit: 54f6cd8323ae86d77edb75cff6fcfe11ba216ff9
parent 540e0acfd384afc753a20c8641d68c4a0f16a806
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Wed, 24 Sep 2025 09:13:50 +0200
README: Move description of Detections up
Diffstat:
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
@@ -34,6 +34,21 @@ Amount of dependencies should be low as it is designed for cases like
[bootstrap-initrd](https://hacktivis.me/git/bootstrap-initrd/).
Which for example means file/libmagic won't be used.
+## Detections
+### Minor
+Throws a warning but doesn't stops reading the file:
+
+- dump: block of 10 consecutive lines with lengths varying by less than 3 bytes (to detect hex dumps, base64, …)
+- more punctuation, symbols, and numbers than letters (within 4KB blocks)
+
+### Major
+Throws an error, stops reading the file, exits unsuccessfully:
+
+- minified code: average line length of more than 100 characters (within 4KB blocks)
+- non-printable character (byte under 0x20 other than `\n`, `\r`, `\t`)
+- 3 blocks of dump (see Minor)
+- (planned) string indicating generated code
+
## Difference with deblob
[deblob](https://hacktivis.me/projects/deblob) is designed for fast
@@ -54,21 +69,6 @@ a list of libmagic-detected MIME types and file extensions.
for known strings of code generators and some generic ones,
also bases itself on libmagic-detected MIME types.
-## Detections
-### Minor
-Throws a warning but doesn't stops reading the file:
-
-- dump: block of 10 consecutive lines with lengths varying by less than 3 bytes (to detect hex dumps, base64, …)
-- more punctuation, symbols, and numbers than letters (within 4KB blocks)
-
-### Major
-Throws an error, stops reading the file, exits unsuccessfully:
-
-- minified code: average line length of more than 100 characters (within 4KB blocks)
-- non-printable character (byte under 0x20 other than `\n`, `\r`, `\t`)
-- 3 blocks of dump (see Minor)
-- (planned) string indicating generated code
-
```
SPDX-FileCopyrightText: 2017 Haelwenn (lanodan) Monnier <contact+checksrc@hacktivis.me>
