Skip to content

Commit eb84e47

Browse files
Improve docs and fix tests
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent c95e85c commit eb84e47

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ binary-inspector is a utility to extract symbols from various kinds of binaries,
55
i.e. ELF, Mach-O, WinPE and other binary formats. It is designed to work as a ScanCode
66
Toolkit plugin and integrated in ScanCode.io pipelines.
77

8-
To install and use:
8+
To install run ``pip install binary-inspector`` and use with::
99

10-
- Run ``pip install binary-inspector``
11-
- Use with ``scancode --json-pp - --macho-symbol --winpe-symbol --verbose <PATH to a tree or file with binaries>``
10+
scancode --json-pp - --macho-symbol --winpe-symbol --verbose <PATH to a tree or file with binaries>
1211

1312
The JSON output will contain binary symbols found in binaries if any.
1413

@@ -85,7 +84,7 @@ Communications Networks, Content and Technology under grant agreement No 1010695
8584
:alt: NLnet foundation logo
8685

8786
.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png
88-
:target: https://ngi.eu35
87+
:target: https://ngi.eu
8988
:height: 50
9089
:alt: NGI logo
9190

@@ -95,7 +94,7 @@ Communications Networks, Content and Technology under grant agreement No 1010695
9594
:alt: nexB logo
9695

9796
.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png
98-
:target: http://ec.europa.eu/index_en.htm
97+
:target: https://commission.europa.eu/index_en
9998
:height: 40
10099
:alt: Europa logo
101100

docs/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Welcome to binary-inspector's documentation!
22
============================================
33

4+
.. include:: ../../README.rst
5+
46
.. toctree::
57
:maxdepth: 2
68
:caption: Contents:

0 commit comments

Comments
 (0)