diff --git a/README.rst b/README.rst index ddc164e1fc..5d9465d0f7 100644 --- a/README.rst +++ b/README.rst @@ -97,7 +97,7 @@ Why use ScanCode? and a few more. See `all available package parsers `_ for the exhaustive list. -See our `roadmap `_ +See our `roadmap `_ for upcoming features. @@ -105,10 +105,10 @@ Documentation ============= The ScanCode documentation is hosted at -`scancode-toolkit.readthedocs.io `_. +`scancode-toolkit.readthedocs.io `_. If you are new to visualization of scancode results data, start with our -`newcomer `_ page. +`newcomer `_ page. If you want to compare output changes between different versions of ScanCode, or want to look at scans generated by ScanCode, review our @@ -116,21 +116,21 @@ or want to look at scans generated by ScanCode, review our Other Important Documentation Pages: -- A `synopsis `_ +- A `synopsis `_ of ScanCode command line options. - Tutorials on: - - `How to run a scan `_ - - `How to visualize scan results `_ + - `How to run a scan `_ + - `How to visualize scan results `_ -- An exhaustive list of `all available options `_ +- An exhaustive list of `all available options `_ -- Documentation on `Contributing to Code Development `_ +- Documentation on `Contributing to Code Development `_ -- Documentation on `Plugin Architecture `_ +- Documentation on `Plugin Architecture `_ -- `FAQ `_ +- `FAQ `_ See also https://aboutcode.org for related companion projects and tools. @@ -142,24 +142,24 @@ Before installing ScanCode make sure that you have installed the prerequisites properly. This means installing Python 3.13 for x86/64 architectures. We support Python 3.10, 3.11, 3.12 and 3.13. -See `prerequisites `_ +See `prerequisites `_ for detailed information on the support platforms and Python versions. -There are a few common ways to `install ScanCode `_. +There are a few common ways to `install ScanCode `_. - `**Installation as an application: Install Python 3.13, download a release archive, extract and run**. - `_ + `_ This is the recommended installation method. - `Development installation from source code using a git clone - `_ + `_ - `Development installation as a library with "pip install scancode-toolkit" - `_ + `_ [Note that this is not supported on arm64 machines] - `Run in a Docker container with a git clone and "docker run" - `_ + `_ - In Fedora 40+ you can `dnf install scancode-toolkit` @@ -171,7 +171,7 @@ After ScanCode is installed successfully you can run an example scan printed on scancode -clip --json-pp - samples -Follow the `How to Run a Scan `_ +Follow the `How to Run a Scan `_ tutorial to perform a basic scan on the ``samples`` directory distributed by default with ScanCode. @@ -180,14 +180,14 @@ See more command examples:: scancode --examples See `How to select what will be detected in a scan -`_ -and `How to specify the output format `_ +`_ +and `How to specify the output format `_ for more information. You can also refer to the `command line options synopsis -`_ +`_ and an exhaustive list of `all available command line options -`_. +`_. Archive extraction @@ -202,8 +202,8 @@ directory:: ./extractcode mytar.tar.bz2 -See `all extractcode options `_ -and `how to extract archives `_ for details. +See `all extractcode options `_ +and `how to extract archives `_ for details. Support @@ -217,7 +217,7 @@ For discussions and chats, we have: * an official Gitter channel for `web-based chats `_. Gitter is now accessible through `Element `_ - or an `IRC bridge `_. + or an `IRC bridge `_. There are other AboutCode project-specific channels available there too. * The discussion channel for `scancode `_ @@ -248,11 +248,11 @@ the third-party code used in ScanCode for more details. .. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop - :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop + :target: https://dev.azure.com/nexB/scancode-toolkit/_build/stable?definitionId=1&branchName=develop :alt: Azure tests status (Linux, macOS, Windows) -.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest - :target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest +.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=stable + :target: https://scancode-toolkit.readthedocs.io/en/stable/?badge=stable :alt: Documentation Status .. |docs-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml/badge.svg?branch=develop