Skip to content

Commit 18d1e16

Browse files
authored
Update README.rst to remove "deep" links to ReadTheDocs
1 parent 5997ac9 commit 18d1e16

File tree

1 file changed

+9
-44
lines changed

1 file changed

+9
-44
lines changed

README.rst

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -12,52 +12,17 @@ ScanCode Toolkit is the leading tool in scanning depth and accuracy, used by hun
1212
Getting Started
1313
===============
1414

15-
These instructions will get you a copy of the project up and running on your local machine.
15+
Instructions to get you up and running on your local machine are at `Getting Started <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/index.html>`_
1616

17-
https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html
17+
The ScanCode Toolkit documentation also provides:
1818

19-
These instructions will guide you to start scanning code.
20-
21-
https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html#synopsis-quickstart
22-
23-
Prerequisites
24-
=============
25-
26-
What things you need to install the software and how to install them.
27-
28-
https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#before-installing
29-
30-
Exploring ScanCode Features
31-
===========================
32-
33-
Discover the ScanCode command line options that meet your requirements.
34-
35-
https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/index.html
36-
37-
Guided Tours
38-
============
39-
40-
These tutorials will provide hands-on guidance to ScanCode features.
41-
42-
https://scancode-toolkit.readthedocs.io/en/stable/tutorials/index.html
43-
44-
Advanced Topics
45-
===============
46-
47-
Expand the ScanCode Licenses and Detection Rules with your own data.
48-
49-
https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/index.html
50-
51-
Generate Attribution from a ScanCode scan.
52-
53-
https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/generate_attribution.html
54-
55-
Contributing
56-
============
57-
58-
Guidelines for contributing to code development.
59-
60-
https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html
19+
- prerequisites for installing the software.
20+
- instructions guiding you to start scanning code.
21+
- a comprehensive guide to the command line options.
22+
- tutorials that provide hands-on guidance to ScanCode features.
23+
- how to expand ScanCode Licenses and Detection Rules with your own data.
24+
- how to generate Attribution from a ScanCode scan.
25+
- guidelines for contributing to code development.
6126

6227
Build and tests status
6328
======================

0 commit comments

Comments
 (0)