Skip to content

Commit 88dc807

Browse files
committed
Improved README to display badges.
* and other refinements
1 parent 58f3059 commit 88dc807

File tree

1 file changed

+54
-28
lines changed

1 file changed

+54
-28
lines changed

README.rst

Lines changed: 54 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ https://github.com/nexB/scancode-toolkit/wiki/Roadmap
2222
.. image:: samples/screenshot.png
2323

2424

25-
2625
Quick Start
2726
===========
2827

@@ -49,6 +48,7 @@ See more command examples::
4948

5049
./scancode --examples
5150

51+
5252
Source code
5353
===========
5454

@@ -72,6 +72,7 @@ Support
7272
If you have a question, a suggestion or find a bug, enter a ticket at:
7373
https://github.com/nexB/scancode-toolkit/issues
7474

75+
7576
Documentation
7677
=============
7778

@@ -96,6 +97,24 @@ To run a scan on sample data, run this::
9697
Then open samples.html in your web browser.
9798

9899

100+
Build and tests status
101+
======================
102+
103+
master branch: Linux and Window:
104+
105+
.. image:: https://api.travis-ci.org/nexB/scancode-toolkit.png?branch=master
106+
:target: https://travis-ci.org/nexB/scancode-toolkit
107+
.. image:: https://ci.appveyor.com/api/projects/status/o3wl8mu4x18nropv/branch/master?png=true
108+
:target: https://ci.appveyor.com/project/nexB/scancode-toolkit
109+
110+
develop branch: Linux and Windows:
111+
112+
.. image:: https://api.travis-ci.org/nexB/scancode-toolkit.png?branch=develop
113+
:target: https://travis-ci.org/nexB/scancode-toolkit
114+
.. image:: https://ci.appveyor.com/api/projects/status/o3wl8mu4x18nropv/branch/develop?png=true
115+
:target: https://ci.appveyor.com/project/nexB/scancode-toolkit
116+
117+
99118
Comprehensive Installation
100119
==========================
101120
ScanCode requires Python 2.7.x and is tested on Linux, Mac, and Windows.
@@ -104,38 +123,44 @@ Make sure Python 2.7 is installed first.
104123
System Requirements
105124
-------------------
106125

107-
Hardware:
126+
**Hardware** :
108127
ScanCode will run best with a modern X86 processor and at least 2GB or Ram and 250MB of disk.
109128

110-
Supported operating Systems. ScanCode should run:
129+
**Supported operating systems** : ScanCode should run on these OSes:
111130

112-
* on most recent 64-bit Linux distributions (32-bit distros are not supported for now),
113-
* on recent Mac OSX (10.6.8 and up),
114-
* and on Windows 7 and up (32- or 64-bit) using a 32-bit Python.
131+
* Linux: on most recent 64-bit Linux distributions (32-bit distros are not supported for now),
132+
* Mac: on recent Mac OSX (10.6.8 and up),
133+
* Windows: on Windows 7 and up (32- or 64-bit) using a 32-bit Python.
115134

116-
On Linux:
135+
Prerequisites
136+
-------------
117137

118-
Use your package manager to install python2.7.
119-
If Python 2.7 is not available from your package manager, you must compile it from sources.
138+
ScanCode needs a Python 2.7 interpreter.
139+
140+
- **On Linux**:
141+
142+
Use your package manager to install `python2.7`.
143+
If Python 2.7 is not available from your package manager, you must compile it from sources.
144+
145+
For instance, visit https://github.com/dejacode/about-code-tool/wiki/BuildingPython27OnCentos
146+
for instruction to compile Python from sources on Centos.
147+
148+
- **On Windows**:
120149

121-
For instance, visit https://github.com/dejacode/about-code-tool/wiki/BuildingPython27OnCentos
122-
for instruction to compile Python from sources on Centos.
150+
Use the Python 2.7 (Windows x86 MSI installer) for X86 regardless of whether you run Windows
151+
on 32-bit or 64-bit. DO NOT USE Python X86_64 even if you run 64 bit Windows.
123152

124-
On Windows:
153+
Download Python from this url:
154+
https://www.python.org/ftp/python/2.7.10/python-2.7.10.msi
125155

126-
ScanCode requires the Python 2.7 (Windows x86 MSI installer)
127-
for X86 regardless of whether you run 32-bit or 64-bit Windows.
128-
DO NOT USE Python X86_64 even if you run 64 bit Windows.
129-
Download Python from this url:
130-
https://www.python.org/ftp/python/2.7.10/python-2.7.10.msi
156+
Install Python on the c: drive and use all default installer options.
157+
See the Windows installation section for more installation details.
131158

132-
Install Python on the c: drive and use all default installer options.
133-
See the Windows installation section for more installation details.
134159

135-
On Mac:
160+
- **On Mac**:
136161

137-
Download Python from this url:
138-
https://www.python.org/ftp/python/2.7.10/python-2.7.10-macosx10.6.pkg
162+
Download and install Python from this url:
163+
https://www.python.org/ftp/python/2.7.10/python-2.7.10-macosx10.6.pkg
139164

140165

141166
Installation on Linux and Mac
@@ -151,11 +176,9 @@ Open a terminal in the extracted directory and run::
151176

152177
This will configure ScanCode and display the command line help.
153178

154-
You can continue to the Usage section.
155179

156-
157-
Windows Installation
158-
--------------------
180+
Installation on Windows
181+
-----------------------
159182

160183
Download the latest ScanCode release zip file from:
161184
https://github.com/nexB/scancode-toolkit/releases/latest
@@ -186,14 +209,16 @@ https://github.com/nexB/scancode-toolkit/releases/latest
186209
scancode -h
187210

188211
* Press enter. This will configure your ScanCode installation.
189-
* Several messages are displayed which will be followed by the scancode command help.
212+
* Several messages are displayed followed by the scancode command help.
213+
* The installation is complete.
190214

191215

192216
===
193217
FAQ
194218
===
219+
195220
Why ScanCode?
196-
==================
221+
=============
197222

198223
We could not find an existing tool (open source or commercial) meeting our needs:
199224

@@ -317,6 +342,7 @@ More (advanced) rules options:
317342

318343
license_choice: yes
319344

345+
320346
How to get started with development?
321347
====================================
322348

0 commit comments

Comments
 (0)