From: Eshel Yaron <me@eshelyaron.com>
Date: Fri, 30 Sep 2022 11:50:18 +0000 (+0300)
Subject: DOC: Added "Getting Started" manual section
X-Git-Tag: v0.4.4
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0e73aafe2feb200744ff316ea1d8ff24e36a2738;p=sweep.git

DOC: Added "Getting Started" manual section
---

diff --git a/README.org b/README.org
index a66a40f..8c83fcc 100644
--- a/README.org
+++ b/README.org
@@ -95,10 +95,27 @@ from the =sweep= Git repository:
      (add-to-list 'load-path "/path/to/sweep")
    #+end_src
 
-3. Load =sweep= into Emacs:
-   #+begin_src emacs-lisp
-     (require 'sweeprolog)
-   #+end_src
+* Getting started
+:PROPERTIES:
+:CUSTOM_ID: getting-started
+:END:
+
+After installing the =sweeprolog= Elisp library, load it into Emacs:
+
+#+begin_src emacs-lisp
+  (require 'sweeprolog)
+#+end_src
+
+All set!  =sweeprolog= automatically loads =sweep-module= and initializes
+the embedded SWI-Prolog runtime.  For a description of the different
+features of =sweep=, see the following sections of this manual.
+
+_Important note for Linux users_: prior to version 29, Emacs would load
+dynamic modules in a way that is not fully compatible with the way the
+SWI-Prolog native library, =libswipl=, loads its own native extensions.
+This may lead to =sweep= failing after loading =sweep-module=.  To work
+around this issue, users running Emacs 28 or earlier on Linux can
+start Emacs with =libswipl= loaded upfront via =LD_PRELOAD=, for example:
 
 * Prolog initialization and cleanup
 :PROPERTIES:
diff --git a/sweeprolog.el b/sweeprolog.el
index 0a6f6bb..a924379 100644
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -6,7 +6,7 @@
 ;; Maintainer: Eshel Yaron <~eshel/dev@lists.sr.ht>
 ;; Keywords: prolog languages extensions
 ;; URL: https://git.sr.ht/~eshel/sweep
-;; Package-Version: 0.4.3
+;; Package-Version: 0.4.4
 ;; Package-Requires: ((emacs "28"))
 
 ;; This file is NOT part of GNU Emacs.