Update installing method in the docs

Author: zinwang

README.md

@@ -66,9 +66,18 @@ With Quark Agent, you can perform analyses using only natural language. It creat
 
 Here’s a demonstration of using Quark Agent to detect the CWE-798 vulnerability in the ovaa.apk file.
 
-### Step 1: Environments Requirements
-
-*   Make sure your Python version is 3.10 or above.
+### Step 1: Environment Requirements
+
+* Make sure your Python version is 3.10 or above.
+* Make sure you have the following packages installed:
+  + C++ Compiler ([GCC13](https://gcc.gnu.org/)/[Microsoft Visual Studio](https://visualstudio.microsoft.com/))
+  + [Cmake](https://cmake.org/)
+  + [Git](https://git-scm.com/)
+  + [iputils-ping](https://github.com/iputils/iputils/tree/master) (Only required for Linux users)
+* Install [Shuriken-Analyzer](https://github.com/Shuriken-Group/Shuriken-Analyzer) by running:
+    ```
+    pip install git+https://github.com/Fare9/Shuriken-Analyzer.git@main#subdirectory=shuriken/bindings/Python/
+    ```
 
 ### Step 2: Install Quark Agent
 

docs/source/install.rst

@@ -2,22 +2,60 @@
 Installing Quark-Engine
 +++++++++++++++++++++++
 
-PyPi::
 
-    $ pip3 install -U quark-engine
+Step 1. Install Shuriken-Analyzer
+--------------------------------------------
 
-Install from Source::
 
-    $ git clone https://github.com/quark-engine/quark-engine.git
-    $ cd quark-engine/
-    $ pipenv install --skip-lock
-    $ pipenv shell
+- Make sure you have the following packages installed:
 
-Run the help cmd of quark::
+  - C++ Compiler (`GCC13 <https://gcc.gnu.org/>`_ or `Microsoft Visual Studio <https://visualstudio.microsoft.com/>`_)
+  - `CMake <https://cmake.org/>`_
+  - `Git <https://git-scm.com/>`_
+  - `iputils-ping <https://github.com/iputils/iputils/tree/master>`_ (Only required for Linux users)
+
+- Install `Shuriken-Analyzer <https://github.com/Shuriken-Group/Shuriken-Analyzer>`_ by running::
+
+    $ pip install git+https://github.com/Fare9/Shuriken-Analyzer.git@main#subdirectory=shuriken/bindings/Python/
+
+- For example, to install Shuriken-Analyzer on Ubuntu, you can run the following commands:
+
+  ::
+
+    $ apt install build-essential g++-13 gcc-13 cmake git iputils-ping
+    $ export CC=gcc-13 CXX=g++-13
+    $ pip install git+https://github.com/Fare9/Shuriken-Analyzer.git@main#subdirectory=shuriken/bindings/Python/
+
+Step 2. Install Quark-Engine
+------------------------------
+
+-  From PyPi:
+
+  ::
+
+        $ pip install -U quark-engine
+
+-  Or you can install Quark-Engine from the source:
+
+  ::
+
+        $ git clone https://github.com/quark-engine/quark-engine.git
+        $ cd quark-engine/
+        $ pipenv install --skip-lock
+        $ pipenv shell
+
+Step 3. Check if Quark-Engine is installed
+---------------------------------------------
+
+- Run the help cmd of quark:
+
+  ::
 
     $ quark --help
 
-Once you see the following msg, then you're all set::
+- Once you see the following message, then you’re all set:
+
+  ::
 
     Usage: quark [OPTIONS]
 
@@ -29,10 +67,12 @@ Once you see the following msg, then you're all set::
       -d, --detail TEXT               Show detail report. Optionally specify the
                                       name of a rule/label
       -o, --output FILE               Output report in JSON
+      -w, --webreport FILE            Generate web report
       -a, --apk FILE                  APK file  [required]
       -r, --rule PATH                 Rules directory  [default:
-                                      /Users/$USER/.quark-engine/quark-rules]
-      -g, --graph                     Create call graph to call_graph_image
+                                      /home/jensen/.quark-engine/quark-
+                                      rules/rules]
+      -g, --graph [png|json]          Create call graph to call_graph_image
                                       directory
       -c, --classification            Show rules classification
       -t, --threshold [100|80|60|40|20]
@@ -43,13 +83,15 @@ Once you see the following msg, then you're all set::
       -l, --label [max|detailed]      Show report based on label of rules
       -C, --comparison                Behaviors comparison based on max confidence
                                       of rule labels
-      --core-library [androguard|rizin]
+      --generate-rule DIRECTORY       Generate rules and output to given directory
+      --core-library [androguard|rizin|radare2|shuriken]
                                       Specify the core library used to analyze an
                                       APK
-      --multi-process INTEGER RANGE   Allow analyzing APK with N processes, 
-                                      where N doesn't exceeds the number of usable CPUs - 1 
-                                      to avoid memory exhaustion.
+      --multi-process INTEGER RANGE   Allow analyzing APK with N processes, where
+                                      N doesn't exceeds the number of usable CPUs
+                                      - 1 to avoid memory exhaustion.  [x>=1]
       --version                       Show the version and exit.
       --help                          Show this message and exit.
 
-To learn how to scan multiple samples in a directory, please have a look at :ref:`Directory Scanning <dir_scan>`
+
+To learn how to scan multiple samples in a directory, please have a look at :ref:`Directory Scanning <dir_scan>`.

docs/source/integration.rst

@@ -7,9 +7,7 @@ Quark Engine Integration In Just 2 Steps
 First Step: Installation
 ------------------------
 
-::
-
-    $ pip3 install -U quark-engine
+You can install Quark-Engine by following :doc:`the instructions <install>`.
 
 Second Step: Code Snippet As You Go
 -----------------------------------

docs/source/quark_agent.rst

@@ -30,6 +30,9 @@ Quick Start
 
    .. code-block::
 
+      apt install build-essential g++-13 gcc-13 cmake git iputils-ping
+      export CC=gcc-13 CXX=g++-13
+      pip install git+https://github.com/Fare9/Shuriken-Analyzer.git@main#subdirectory=shuriken/bindings/Python/
       pip install -r requirements.txt
 
 3. Add your OpenAI API key in quarkScriptAgent.py.

docs/source/quark_script.rst

@@ -40,11 +40,7 @@ Step 1: Environments Requirements
 Step 2: Install Quark Engine
 =============================
 
-You can install Quark Engine by running:
-
-::
-
-    $ pip3 install quark-engine
+- You can install Quark-Engine by following :doc:`the instructions <install>`.
 
 
 Step 3: Prepare Quark Script, Detection Rule and the Sample File