Skip to content

Commit

Permalink
Merge pull request #22 from nexB/readme-update
Browse files Browse the repository at this point in the history
Update README with Pygments and Tree-Sitter example
  • Loading branch information
keshav-space authored May 6, 2024
2 parents 3cf6700 + 000644e commit 01ae97f
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ source-inspector
================================

source-inspector is a set of utilities to inspect and analyze source
code and collect interesting data using various tools such as code symbols and strings.
code and collect interesting data using various tools such as code symbols, strings and comments.
This is also a ScanCode-toolkit plugin.

Homepage: https://github.com/nexB/source-inspector
Expand Down Expand Up @@ -46,4 +46,11 @@ To get started:
5. Run a basic scan to collect strings and display as YAML on screen::

scancode --source-string tests/data/symbols_ctags/test3.cpp --yaml -

6. Run a basic scan to collect symbols, strings and comments using `Pygments <https://pygments.org/>`_, and display them as YAML on the screen::

scancode --pygments-symbol-and-string tests/data/symbols_ctags/test3.cpp --yaml -

7. Run a basic scan to collect symbols and strings using `Tree-Sitter <https://tree-sitter.github.io/tree-sitter/>`_, and display them as YAML on the screen::

scancode --treesitter-symbol-and-string tests/data/symbols_ctags/test3.cpp --yaml -

0 comments on commit 01ae97f

Please sign in to comment.