Skip to content

Commit 8fc64be

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Move Install guides from README.rst to INSTALL.rst
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 3d39090 commit 8fc64be

2 files changed

Lines changed: 71 additions & 59 deletions

File tree

‎INSTALL.rst‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
============
2+
Installation
3+
============
4+
5+
There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
6+
7+
- Installation as an Application: Downloading Releases (Recommended)
8+
- Installation as a library: via pip
9+
- Installation from Source Code: Git Clone
10+
11+
Prerequisites
12+
-------------
13+
14+
Before installing ScanCode make sure you've installed the prerequisites properly. This mainly
15+
refers to installing the required Python interpreter (Python 3.6 is recommended).
16+
17+
- For Linux(Ubuntu): ``sudo apt install python3.6-dev bzip2 xz-utils zlib1g libxml2-dev libxslt1-dev``
18+
- For MacOS: Install Python 3.6.8 from https://www.python.org/ftp/python/3.6.8/python-3.6.8-macosx10.6.pkg
19+
- For Windows: Install Python 3.6.8 from https://www.python.org/ftp/python/3.6.8/python-3.6.8.exe
20+
21+
Refer `Prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_ for detailed information on all different platforms and Python Versions.
22+
23+
Installation as an Application : Downloading Releases
24+
-----------------------------------------------------
25+
26+
#. Download and extract the latest ScanCode release from https://github.com/nexB/scancode-toolkit/releases/
27+
28+
#. Open a terminal window and then `cd` to the extracted ScanCode directory.
29+
30+
#. Run this command to self-configure and display the help-text.
31+
32+
- Linux/Mac : ``./scancode --help``
33+
- Windows : ``scancode --help``
34+
35+
Installation as a library: via pip
36+
----------------------------------
37+
38+
#. Create a Python 3.6 Virtual Environment and activate the same::
39+
40+
virtualenv -p /usr/bin/python3.6 venv-scancode && source venv-scancode/bin/activate
41+
42+
#. Run ``pip install scancode-toolkit``
43+
44+
Installation from Source Code: Git Clone
45+
----------------------------------------
46+
47+
#. Download the Source Code or Use Git Clone::
48+
49+
git clone https://github.com/nexB/scancode-toolkit.git
50+
cd scancode-toolkit
51+
52+
#. You can jump to any checkpoint/Branch/Commit using the following command::
53+
54+
git checkout master
55+
56+
#. Run the Configure Script
57+
58+
- On Linux/Mac: ``./configure``
59+
- On Windows: ``configure``
60+
61+
62+
Note the `Commands will vary <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_ across different Installation methods and Platforms.
63+
64+
If this displays the `Help Text <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/help-text-options.html#help-text>`_, you are all set to start using ScanCode.

‎README.rst‎

Lines changed: 7 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Why use ScanCode?
1212
=================
1313

1414
- As a **standalone command line tool**, ScanCode is **easy to install**, run
15-
and embed in your CI/CD processing pipeline. It runs on **Windows, MacOS and Linux**.
15+
and embed in your CI/CD processing pipeline. It runs on **Windows, macOS and Linux**.
1616

1717
- ScanCode is **used by several projects and organizations** such as the `Eclipse
1818
Foundation <https://www.eclipse.org>`_, `OpenEmbedded.org <https://www.openembedded.org>`_,
@@ -87,67 +87,15 @@ See also https://aboutcode.org for related companion projects and tools.
8787
Installation
8888
============
8989

90-
There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
91-
92-
- Installation as an Application: Downloading Releases (Recommended)
93-
- Installation as a library: via pip
94-
- Installation from Source Code: Git Clone
95-
96-
Prerequisites
97-
-------------
98-
9990
Before installing ScanCode make sure you've installed the prerequisites properly. This mainly
100-
refers to installing the required Python interpreter (Python 3.6 is recommended).
101-
102-
- For Linux(Ubuntu): ``sudo apt install python3.6-dev bzip2 xz-utils zlib1g libxml2-dev libxslt1-dev``
103-
- For MacOS: Install Python 3.6.8 from https://www.python.org/ftp/python/3.6.8/python-3.6.8-macosx10.6.pkg
104-
- For Windows: Install Python 3.6.8 from https://www.python.org/ftp/python/3.6.8/python-3.6.8.exe
105-
106-
Refer `Prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_ for detailed information on all different platforms and Python Versions.
107-
108-
Installation as an Application : Downloading Releases
109-
-----------------------------------------------------
110-
111-
#. Download and extract the latest ScanCode release from https://github.com/nexB/scancode-toolkit/releases/
112-
113-
#. Open a terminal window and then `cd` to the extracted ScanCode directory.
114-
115-
#. Run this command to self-configure and display the help-text.
116-
117-
- Linux/Mac : ``./scancode --help``
118-
- Windows : ``scancode --help``
119-
120-
Installation as a library: via pip
121-
----------------------------------
122-
123-
#. Create a Python 3.6 Virtual Environment and activate the same::
91+
refers to installing the required Python interpreter (Python 3.6 is recommended). Refer
92+
`Prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_ for detailed information on all different platforms and Python Versions.
12493

125-
virtualenv -p /usr/bin/python3.6 venv-scancode && source venv-scancode/bin/activate
126-
127-
#. Run ``pip install scancode-toolkit``
128-
129-
Installation from Source Code: Git Clone
130-
----------------------------------------
131-
132-
#. Download the Source Code or Use Git Clone::
133-
134-
git clone https://github.com/nexB/scancode-toolkit.git
135-
cd scancode-toolkit
136-
137-
#. You can jump to any checkpoint/Branch/Commit using the following command::
138-
139-
git checkout master
140-
141-
#. Run the Configure Script
142-
143-
- On Linux/Mac: ``./configure``
144-
- On Windows: ``configure``
145-
146-
147-
Note the `Commands will vary <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_ across different Installation methods and Platforms.
148-
149-
If this displays the `Help Text <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/help-text-options.html#help-text>`_, you are all set to start using ScanCode.
94+
There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
15095

96+
- `Installation as an Application: Downloading Releases <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#download-and-configure-latest-release>`_ *(Recommended)*
97+
- `Installation as a library: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-by-pip>`_
98+
- `Installation from Source Code: Git Clone <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#build-from-source>`_
15199

152100
Quick Start
153101
===========

0 commit comments

Comments
 (0)