Skip to content

Commit 019b94f

Browse files
committed
Fix typos in the document
1 parent ce91328 commit 019b94f

File tree

2 files changed

+21
-22
lines changed

2 files changed

+21
-22
lines changed

docs/source/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Once you see the following msg, then you're all set::
3131
-o, --output FILE Output report in JSON
3232
-a, --apk FILE APK file [required]
3333
-r, --rule PATH Rules directory [default:
34-
/home/haeter/.quark-engine/quark-rules]
34+
/home/$USER/.quark-engine/quark-rules]
3535
-g, --graph [png|json] Create call graph to call_graph_image
3636
directory
3737
-c, --classification Show rules classification

docs/source/testing.rst

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,47 +15,46 @@ Then we could test one of the apk in `apk-malware-samples` by the rules `quark-r
1515
1616
$ quark -a Ahmyth.apk -s
1717
18-
Running analyses based on Rizin
19-
==================
20-
21-
Now Quark also supports `Rizin`_ as one of our Android analysis frameworks. You can use option ``--core-library`` with ``rizin`` to enable the Rizin-based analysis library.
18+
Running in Docker
19+
=================
2220

23-
.. _`Rizin`: https://github.com/rizinorg/rizin
21+
We could build the corresponding docker image by this command:
2422

2523
.. code-block:: bash
2624
27-
quark -a Ahmyth.apk -s --core-library rizin
28-
25+
docker build . -t quark
2926
30-
For now, Quark is compatible with Rizin v0.4.0. But, users don't have to installed a Rizin with that version. Quark provides a feature to automatically setup a independent Rizin. In this way, the dependency will not conflict with your environment. Type in the above command and let Quark handle everything else for you.
3127
32-
If there is a working installation of Rizin installed in the system, Quark will check its version to determine if it is compatible. If true, Quark automatically uses it for the analysis. Otherwise, Quark uses the independent Rizin installed in the Quark directory (``~/.quark-engine``).
28+
When the image is ready, let's run an example to test the image:
3329

34-
You can use option ``--rizin-path`` to specify the path of the Rizin executable.
30+
You may also interactively use quark in the docker container. For example:
3531

3632
.. code-block:: bash
3733
38-
quark -a Ahmyth.apk -s --core-library rizin --rizin-path path_to_a_rizin_executable
34+
$ docker run -v $(pwd):/tmp -it quark bash
35+
(in-docker): /app/quark# cd /tmp
36+
(in-docker)::/tmp# quark -a Ahmyth.apk -s
3937
40-
Moreover, if you don't want Quark to install an independent Rizin, you can use the flag ``--disable-rizin-installation`` to disable this feature.
38+
Running analyses based on Rizin (Upcoming unstable feature)
39+
===========================================================
4140

42-
Running in Docker
43-
=================
41+
Now Quark also supports `Rizin`_ as one of our Android analysis frameworks. You can use option ``--core-library`` with ``rizin`` to enable the Rizin-based analysis library.
4442

45-
We could build the corresponding docker image by this command:
43+
.. _`Rizin`: https://github.com/rizinorg/rizin
4644

4745
.. code-block:: bash
4846
49-
docker build . -t quark
47+
quark -a Ahmyth.apk -s --core-library rizin
5048
5149
52-
When the image is ready, let's run an example to test the image:
50+
For now, Quark is compatible with Rizin v0.3.4. But, users don't have to installed a Rizin with that version. Quark provides a feature to automatically setup a independent Rizin. In this way, the dependency will not conflict with your environment. Type in the above command and let Quark handle everything else for you.
5351

54-
You may also interactively use quark in the docker container. For example:
52+
If there is a working installation of Rizin installed in the system, Quark will check its version to determine if it is compatible. If true, Quark automatically uses it for the analysis. Otherwise, Quark uses the independent Rizin installed in the Quark directory (``~/.quark-engine``).
53+
54+
You can use option ``--rizin-path`` to specify the path of the Rizin executable.
5555

5656
.. code-block:: bash
5757
58-
$ docker run -v $(pwd):/tmp -it quark bash
59-
(in-docker): /app/quark# cd /tmp
60-
(in-docker)::/tmp# quark -a Ahmyth.apk -s
58+
quark -a Ahmyth.apk -s --core-library rizin --rizin-path path_to_a_rizin_executable
6159
60+
Moreover, if you don't want Quark to install an independent Rizin, you can use the flag ``--disable-rizin-installation`` to disable this feature.

0 commit comments

Comments
 (0)