branch: externals/beardbolt
commit 98f766bdfcd90a51b91308a9ab39a4135fe3cdd6
Author: João Távora <joaotav...@gmail.com>
Commit: João Távora <joaotav...@gmail.com>
Add a README.md
* README.md: New file.
---
README.md | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..f385a18905
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+
+# beardbolt
+
+An experimental fork of [rmsbolt](https://gitlab.com/jgkamat/rmsbolt),
+itself a supercharged implementation of [godbolt
+compiler-explorer](https://github.com/mattgodbolt/compiler-explorer)
+for Emacs.
+
+beardbolt tries to make it easy to see what your compiler is doing.
+It does this by showing you the assembly output of a given source code
+file. It also highlights which source code a given assembly block
+corresponds to, and vice versa.
+
+### Why rmsbolt over beardbolt
+
+- Supports more languages/compilers. beardbolt only C++/C clang/gcc.
+- Has good documentation and a proper API.
+- Supports more Emacs versions. beardbolt only 28+
+- Support compile-commands.json
+
+### Why beardbolt over rmsbolt
+
+- Doesn't require file to be saved.
+- Faster (2x) and more responsive (TODO: show benchmarks)
+- Less buggy (TODO: show actual rmsbolt problems)
+- Has rainbows.
+- Has `beardbolt-preserve-library-functions` switch like godbolt.
+- Simpler code (half the LOC)
+
+### Installation
+
+```lisp
+(add-to-list 'load-path "/path/to/beardbolt-clone")
+(require 'beardbolt)
+```
