prettify this repo

BromaToIDA/utils.py

@@ -112,14 +112,14 @@ def register_btida(hotkey: str, f: Callable):
     try:
         hotkey_ctx  # type: ignore
         if del_hotkey(hotkey_ctx):  # type: ignore
-            print("Hotkey unregistered!")
+            print("[+] Hotkey unregistered!")
             del hotkey_ctx  # type: ignore
         else:
-            print("Failed to delete hotkey!")
+            print("[!] Failed to delete hotkey!")
     except:
         hotkey_ctx = add_hotkey(hotkey, f)
         if hotkey_ctx is None:
-            print("Failed to register hotkey!")
+            print("[!] Failed to register hotkey!")
             del hotkey_ctx
         else:
-            print("Hotkey registered!")
+            print("[+] Hotkey registered!")

MiniBromaToIDA.py

@@ -197,17 +197,17 @@ def register_btida(hotkey: str, f: Callable):
     try:
         hotkey_ctx  # type: ignore
         if del_hotkey(hotkey_ctx):  # type: ignore
-            print("Hotkey unregistered!")
+            print("[+] Hotkey unregistered!")
             del hotkey_ctx  # type: ignore
         else:
-            print("Failed to delete hotkey!")
+            print("[!] Failed to delete hotkey!")
     except:
         hotkey_ctx = add_hotkey(hotkey, f)
         if hotkey_ctx is None:
-            print("Failed to register hotkey!")
+            print("[!] Failed to register hotkey!")
             del hotkey_ctx
         else:
-            print("Hotkey registered!")
+            print("[+] Hotkey registered!")
 
 
 RX_CLASS = r"""class (\S+)( : (.*))? \{"""
@@ -433,7 +433,10 @@ def main():
                     set_func_cmt(ida_addr, f"Merged with: {func_names}", True)
 
         print("[+] Finished importing bindings from broma file")
-        popup("Ok", "Ok", None, "Finished importing Windows bindings from broma file.")
+        popup(
+            "Ok", "Ok", None,
+            "Finished importing Windows bindings from broma file."
+        )
 
 
 register_btida("Ctrl-Shift-I", main)

README.md

@@ -1,2 +1,23 @@
 # Broma-To-IDA
-(now real)
+
+Broma to IDA (now real).
+
+Parses a broma file and imports the bindings into the current IDA project.
+
+[![Broma-To-IDA](assets/btida.gif)](https://github.com/SpaghettDev/Broma-To-IDA/releases)
+
+## Requirements
+
+- IDA 7.0 or higher
+- IDAPython Python v3.0.0 support
+
+## Installation
+
+1. Download the release/zip file
+2. Copy `MiniBromaToIDA.py` into `IDA_DIRECTORY/plugins`
+
+## Usage
+
+1. `Ctrl-Shift-I` to start importing
+2. Browse and select the broma file (not tested with anything but `GeometryDash.bro`)
+3. Let the script handle the rest and enjoy free bindings