1.4 release

Author: kernelwernel

TODO.md

@@ -32,7 +32,7 @@
 - [ ] make a man file in markdown for the cli tool
 - [ ] implement smbios version technique [here](https://github.com/Print3M/Anti-VM/blob/eb524ed89e783b36c149acc450b2350d4198b06b/detectors.cpp#L88)
 - [ ] implement a display size technique for linux with EDID 
-- [ ] implement a technique that matches the CPU product name and match it with a database of core counts for that specific CPU product
+- [X] implement a technique that matches the CPU product name and match it with a database of core counts for that specific CPU product
 - [ ] add usage example in the .hpp file directly below the banner
 
 # Distant plans

auxiliary/updater.py

@@ -88,9 +88,7 @@ def update(filename):
         " * - start of internal VM detection techniques => line __TECHNIQUES__",
         " * - struct for internal core components       => line __CORE__",
         " * - start of public VM detection functions    => line __PUBLIC__",
-        " * - start of externally defined variables     => line __EXTERNAL__",
-        " */",
-        ""
+        " * - start of externally defined variables     => line __EXTERNAL__"
     ]
 
     # replace the macro strings with the file line numbers

src/vmaware.hpp

@@ -19,17 +19,36 @@
  *  - Full credits: https://github.com/kernelwernel/VMAware#credits-and-contributors-%EF%B8%8F
  *  - License: GPL-3.0
  *
+ * 
  * ================================ SECTIONS ==================================
- * - enums for publicly accessible techniques  => line 252
- * - struct for internal cpu operations        => line 447
- * - struct for internal memoization           => line 684
- * - struct for internal utility functions     => line 757
- * - struct for internal core components       => line 5713
- * - start of internal VM detection techniques => line 1423
- * - start of public VM detection functions    => line 5786
- * - start of externally defined variables     => line 6053
+ * - enums for publicly accessible techniques  => line 282
+ * - struct for internal cpu operations        => line 480
+ * - struct for internal memoization           => line 772
+ * - struct for internal utility functions     => line 834
+ * - struct for internal core components       => line 7073
+ * - start of internal VM detection techniques => line 1510
+ * - start of public VM detection functions    => line 7187
+ * - start of externally defined variables     => line 7487
+ * 
+ * 
+ * ================================ EXAMPLE ==================================
+#include "vmaware.hpp"
+#include <iostream>
+
+int main() {
+    if (VM::detect()) {
+        std::cout << "Virtual machine detected!" << std::endl;
+        std::cout << "VM name: " << VM::brand() << std::endl;
+    } else {
+        std::cout << "Running in baremetal" << std::endl;
+    }
+    
+    std::cout << "VM certainty: " << (int)VM::percentage() << "%" << std::endl;
+}
+
  */
 
+
 #if (defined(_MSC_VER) || defined(_WIN32) || defined(_WIN64) || defined(__MINGW32__))
 #define MSVC 1
 #define LINUX 0