[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/beardbolt 2c798336b8 292/323: Tweak README.md
From: |
ELPA Syncer |
Subject: |
[elpa] externals/beardbolt 2c798336b8 292/323: Tweak README.md |
Date: |
Thu, 9 Mar 2023 10:58:47 -0500 (EST) |
branch: externals/beardbolt
commit 2c798336b8a7dc53eccb11bdee7966e4a907a0ed
Author: João Távora <joaotavora@gmail.com>
Commit: João Távora <joaotavora@gmail.com>
Tweak README.md
---
README.md | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 9a7a9d03b5..36ac819927 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,31 @@
# Beardbolt
+![beardbolt in action](./beardbolt.gif)
+
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.
+Beardbolt shows you assembly output for given source code file, making
+it easy to see what your compiler is doing.
+
+It also highlights which source code corresponds to a given assembly,
+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
+- Supports more Emacs versions. Beardbolt probably only 28+
### Why Beardbolt over RMSbolt
- Doesn't require file to be saved.
-- 2-5x faster on typical files. See [here][#benchmarks])
+- 2-5x faster on typical files. See [here](#benchmarks).
- Less buggy (TODO: show actual RMSbolt problems)
- Has rainbows.
-- Simpler code (less than half the LOC, but )
+- Simpler code (less than half the LOC, but also less funcional).
### Installation
@@ -101,15 +103,13 @@ Beardbolt timings for unordered-multimap-emplace.cpp
```
This ran `beardbolt-compile` and `rmsbolt-compile` 5 times on small
-two [cppreference.com][https://cppreference.com] examples
+two [cppreference.com](https://cppreference.com) examples
([1][example1], [2][example2]) as well as a known "slow" file found in
-RMSbolt's bug tracker
-([here](https://gitlab.com/jgkamat/rmsbolt/-/issues/9)).
+[RMSbolt's bug tracker](https://gitlab.com/jgkamat/rmsbolt/-/issues/9).
-I patched `rmsbolt.el` to generate slightly less useless (for our use
-case) debug information with `-g1` instead of `g`. This makes RMSbolt
-run faster than it normally would, but since Beardbolt also uses this
-optimization, it is important to make the benchmarks fair(er?).
+To make the benchmark fair(er?) I patched `rmsbolt.el` to generate
+slightly less debug with `-g1` instead of `-g`, and thus benefit from
+the same speedup that `beardbolt.el` uses.
The results were obtained on my Thinkpad T480 running Emacs 29
(without native compilation).
- [elpa] externals/beardbolt 3fe322e573 242/323: Merge branch 'improve-auto-compilation' into 'master', (continued)
- [elpa] externals/beardbolt 3fe322e573 242/323: Merge branch 'improve-auto-compilation' into 'master', ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 194e7ea9dc 253/323: Dumb rename rmsbolt->bearbold, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 3870c30bbd 257/323: Move test/*test.el to beardbolt-tests.el, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 98f766bdfc 270/323: Add a README.md, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 28fc329861 262/323: Rework bb-compile a bit, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt f491a6adb2 278/323: Rework to use write-region, use a little less memory, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 2633e20e66 274/323: * beardbolt.el (bb--reachable-p): Rework for small speed gain., ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 60fa7a3c05 280/323: Force asm output to be of a certain format, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt b2dc0eb81d 284/323: Make beardbolt-disassemble work again, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 730ea84796 290/323: bb-compile-delay can be nil, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 2c798336b8 292/323: Tweak README.md,
ELPA Syncer <=
- [elpa] externals/beardbolt c05a0be490 297/323: Add useful beardbolt-preserve-library-functions, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 26c0b918e4 301/323: Tweak README.md again, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt e1e69080b7 303/323: Rename "output buffer" -> "asm buffer", ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt dbafc4a88c 304/323: Minor cleanup, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 68469cfb57 306/323: More misc minor rework to simplify code, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 02a0bfbcdb 313/323: Add `beardbolt-ccj-extra-flags` option, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 6a71a16619 319/323: Simplify rainbow-clearing logic, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt e403331350 322/323: * beardbolt.el (bb--synch-relation-overlays): Fix bug., ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt 4a6f289c94 002/323: Add very basic compilation of c files, ELPA Syncer, 2023/03/09
- [elpa] externals/beardbolt ac893146e3 019/323: Force dissasembly if we don't support asm, ELPA Syncer, 2023/03/09