branch: externals/emacs-gc-stats
commit 30340df54c11e0e665fcd5372876a52dcc0f1ef3
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
Use Org for README source
* README.org: New file, containing `after-save-hook' for md export.
* README.md: Re-generate.
---
README.md | 16 ++++++++--------
README.org | 24 ++++++++++++++++++++++++
2 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 517322f6b4..27ab27b449 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,16 @@
This package collects Emacs garbage statistics over time and saves it
in the format that can be shared with Emacs maintainers.
+
# Usage
Add
-``` lisp
-(require 'emacs-gc-stats)
-;; optional
-(setq gc-cons-threshold
- (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
-(emacs-gc-stats-mode +1)
-```
+ (require 'emacs-gc-stats)
+ ;; optional
+ (setq gc-cons-threshold
+ (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
+ (emacs-gc-stats-mode +1)
to your init file to enable the statistics acquiring.
@@ -19,5 +18,6 @@ When you are ready to share the results, run `M-x
emacs-gc-stats-save-session`
and then share the saved `emacs-gc-stats-file` (defaults to
`~/.emacs.d/emacs-gc-stats.eld`).
-You can use `emacs-gc-stats-clear` to clear the currently collected
+You can use `M-x emacs-gc-stats-clear` to clear the currently collected
session data.
+
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..d6ef6967ab
--- /dev/null
+++ b/README.org
@@ -0,0 +1,24 @@
+# -*- after-save-hook: (org-md-export-to-markdown); -*-
+#+options: toc:nil
+
+This package collects Emacs garbage statistics over time and saves it
+in the format that can be shared with Emacs maintainers.
+
+* Usage
+
+Add
+#+begin_src emacs-lisp
+(require 'emacs-gc-stats)
+;; optional
+(setq gc-cons-threshold
+ (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
+(emacs-gc-stats-mode +1)
+#+end_src
+to your init file to enable the statistics acquiring.
+
+When you are ready to share the results, run =M-x emacs-gc-stats-save-session=
+and then share the saved ~emacs-gc-stats-file~ (defaults to
+=~/.emacs.d/emacs-gc-stats.eld=).
+
+You can use =M-x emacs-gc-stats-clear= to clear the currently collected
+session data.
