From 9ef1b53acae509bf72766df8592bfec97205cc6a Mon Sep 17 00:00:00 2001 From: troyyyyy Date: Sun, 7 Jan 2024 10:21:03 +0800 Subject: [PATCH] [ENH] add subtitle in installation --- README.md | 22 ++++++++++++++-------- docs/Overview/Installation.rst | 25 +++++++++++++++++-------- docs/README.rst | 25 +++++++++++++++++-------- 3 files changed, 48 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2cb09eb..b0e9e03 100644 --- a/README.md +++ b/README.md @@ -32,32 +32,38 @@ To learn how to use it, please refer to - [document](https://www.lamda.nju.edu.c ## Installation +### Install from PyPI + The easiest way to install ABL-Package is using ``pip``: ```bash # (TODO) -$ pip install abl +pip install abl ``` For testing purposes, you can install it using: ```bash -$ pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl +pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl ``` -Alternatively, to install by source code, sequentially run following commands in your terminal/command line. +### Install from Source + +Alternatively, to install from source code, sequentially run following commands in your terminal/command line. ```bash -$ git clone https://github.com/AbductiveLearning/ABL-Package.git -$ cd ABL-Package -$ pip install -v -e . +git clone https://github.com/AbductiveLearning/ABL-Package.git +cd ABL-Package +pip install -v -e . ``` -(Optional) If the use of a [Prolog-based knowledge base](https://www.lamda.nju.edu.cn/abl_test/docs/build/html/Intro/Reasoning.html#prolog) is necessary, the installation of [Swi-Prolog](https://www.swi-prolog.org/) is also required: +### (Optional) Install Swi-Prolog + +If the use of a [Prolog-based knowledge base](https://www.lamda.nju.edu.cn/abl_test/docs/build/html/Intro/Reasoning.html#prolog) is necessary, please also install [Swi-Prolog](https://www.swi-prolog.org/): For Linux users: ```bash -$ sudo apt-get install swi-prolog +sudo apt-get install swi-prolog ``` For Windows and Mac users, please refer to the [Swi-Prolog Install Guide](https://github.com/yuce/pyswip/blob/master/INSTALL.md). diff --git a/docs/Overview/Installation.rst b/docs/Overview/Installation.rst index 2ab95ac..2f21628 100644 --- a/docs/Overview/Installation.rst +++ b/docs/Overview/Installation.rst @@ -1,34 +1,43 @@ Installation ================== +Install from PyPI +^^^^^^^^^^^^^^^^^ + The easiest way to install ABL-Package is using ``pip``: .. code:: console # (TODO) - $ pip install abl + pip install abl For testing purposes, you can install it using: .. code:: console - $ pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl + pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl + +Install from Source +^^^^^^^^^^^^^^^^^^^ -Alternatively, to install by source code, +Alternatively, to install from source code, sequentially run following commands in your terminal/command line. .. code:: console - $ git clone https://github.com/AbductiveLearning/ABL-Package.git - $ cd ABL-Package - $ pip install -v -e . + git clone https://github.com/AbductiveLearning/ABL-Package.git + cd ABL-Package + pip install -v -e . + +(Optional) Install Swi-Prolog +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -(Optional) If the use of a :ref:`Prolog-based knowledge base ` is necessary, the installation of `Swi-Prolog `_ is also required: +If the use of a :ref:`Prolog-based knowledge base ` is necessary, the installation of `Swi-Prolog `_ is also required: For Linux users: .. code:: console - $ sudo apt-get install swi-prolog + sudo apt-get install swi-prolog For Windows and Mac users, please refer to the `Swi-Prolog Install Guide `_. \ No newline at end of file diff --git a/docs/README.rst b/docs/README.rst index f4e69a7..e0dc892 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -21,35 +21,44 @@ which leverage the power of both data and knowledge. Installation ------------ +Install from PyPI +^^^^^^^^^^^^^^^^^ + The easiest way to install ABL-Package is using ``pip``: .. code:: console # (TODO) - $ pip install abl + pip install abl For testing purposes, you can install it using: .. code:: console - $ pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl + pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl + +Install from Source +^^^^^^^^^^^^^^^^^^^ -Alternatively, to install by source code, +Alternatively, to install from source code, sequentially run following commands in your terminal/command line. .. code:: console - $ git clone https://github.com/AbductiveLearning/ABL-Package.git - $ cd ABL-Package - $ pip install -v -e . + git clone https://github.com/AbductiveLearning/ABL-Package.git + cd ABL-Package + pip install -v -e . + +(Optional) Install Swi-Prolog +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -(Optional) If the use of a :ref:`Prolog-based knowledge base ` is necessary, the installation of `Swi-Prolog `_ is also required: +If the use of a :ref:`Prolog-based knowledge base ` is necessary, the installation of `Swi-Prolog `_ is also required: For Linux users: .. code:: console - $ sudo apt-get install swi-prolog + sudo apt-get install swi-prolog For Windows and Mac users, please refer to the `Swi-Prolog Install Guide `_.