branch: externals/beardbolt
commit 8cfb5b19686d589f3b16303b1fa7789e41dd302e
Author: Jay Kamat <jaygka...@gmail.com>
Commit: Jay Kamat <jaygka...@gmail.com>
Upgrade information and docs for melpa
---
README.org | 5 +++--
rmsbolt.el | 31 +++++++++++++++++++++++++++++++
2 files changed, 34 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index e7a9a0ae4d..0c9de82768 100644
--- a/README.org
+++ b/README.org
@@ -40,8 +40,9 @@ rmsbolt will almost certainly not work naively on windows as
it depends on a
unix shell for building the compilation commands. It may work through cygwin
though.
-rmsbolt is not on melpa yet. If you find it useful, please let me know and I
may
-add it..
+** Melpa
+
+[[http://melpa.org/#/rmsbolt][A melpa package is available for rmsbolt]].
** Quelpa
diff --git a/rmsbolt.el b/rmsbolt.el
index fa61794b55..fbb1cf02cb 100644
--- a/rmsbolt.el
+++ b/rmsbolt.el
@@ -22,6 +22,37 @@
;;; Commentary:
;; rmsbolt is a package to provide assembly or bytecode output for a source
code input file.
+;;
+;; It currently supports: C/C++, OCaml, Haskell, Python, Java, and (limited)
Common Lisp.
+;; Adding support for more languages, if they have an easy manual compilation
+;; path from source->assembly/bytecode with debug information, should be much
+;; easier than in other alternatives.
+;;
+;; It's able to do this by:
+;; 1. Compiling changes automatically, adding options which cause the compiler
+;; to output assembly/bytecode with debug information (or by using objdump)
+;; 2. Parse assembly/bytecode to create a map from it to the original source
+;; 3. Strip out unneeded information from bytecode to only show useful code
+;; 4. Provide an interface for highlighting the matched assembly/bytecode line
+;; to the source and vice versa
+;;
+;; Tweakables:
+;; RMSBolt is primarily configured with Emacs local variables. This lets you
+;; change compiler and rmsbolt options simply by editing a local variable
block.
+;;
+;; Notable options:
+;; `rmsbolt-command': determines the prefix of the compilation command to use
+;; `rmsbolt-dissasemble': dissasemble from a compiled binary with objdump, if
supported.
+;; `rmsbolt-filter-*': Tweak filtering of binary output
+;; `rmsbolt-intel-x86': Toggle between intel and att syntax if supported
+;; `rmsbolt-demangle': Demangle the output, if supported.
+;;
+;; Please see the readme at https://gitlab.com/jgkamat/rmsbolt for more
information!
+;;
+;; Thanks:
+;; Inspiration and some assembly parsing logic was adapted from Matt Godbolt's
+;; compiler-explorer: https://github.com/mattgodbolt/compiler-explorer and
+;; Jonas Konrad's javap: https://github.com/yawkat/javap.
;;; Requires:
