Skip to content

Commit d3a95a1

Browse files
authored
Merge pull request #631 from nexB/docs/installation-steps
Updated installation note for centos & macos, fixed minor typos in docs
2 parents 61bd5fa + 5024c7f commit d3a95a1

File tree

5 files changed

+18
-3
lines changed

5 files changed

+18
-3
lines changed

CHANGELOG.rst

+5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Changelog <https://keepachangelog.com/en/1.0.0/>`__
88
[v4.0.3] - Unreleased
99
--------------------------
1010

11+
Docs
12+
~~~~~~~~~
13+
14+
- Update macOS installation steps by @OmkarPh in #631
15+
1116

1217
[v4.0.2] - 2024-02-28
1318
--------------------------

Release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This v4.0.2 of ScanCode Workbench is compatible with scans from any [ScanCode To
1414

1515
## Framework
1616

17-
- Electorn [v28.1.0](https://releases.electronjs.org/release/v28.1.0)
17+
- Electron [v28.1.0](https://releases.electronjs.org/release/v28.1.0)
1818
- Chromium [v120.0.6099.109](https://source.chromium.org/chromium/chromium/src/+/refs/tags/120.0.6099.109:)
1919

2020
<!-- # New Contributors -->

docs/source/getting-started/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@ Download and Install
1616

1717
On Windows 10, for example, the executable will be named `ScanCode-Workbench-4.0.1.exe`.
1818

19+
.. Note::
20+
Browsers on MacOS add a ``com.apple.quarantine`` extended attribute to downloaded apps.
21+
which prevents you from running the app & shows error dialog: `Application Is Damaged and Can’t Be Opened. You Should Move It To The Trash <https://discussions.apple.com/thread/253714860>`__
22+
23+
Delete the attribute using ``xattr`` utility before running the app for first time:
24+
25+
.. code-block:: bash
26+
27+
xattr -d com.apple.quarantine ~/Downloads/ScanCode-Workbench-4.0.2-darwin-arm64/ScanCode-Workbench-4.0.2.app
28+
1929
.. include:: ../rst_snippets/centos-note.rst
2030

2131
- If you're interested in digging into the code, you can also use ScanCode Workbench by cloning

docs/source/overview/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Underlying Technology
3737
- ScanCode Workbench is a cross-platform application built using the `Electron <https://www.electronjs.org/>`__ framework that works on Windows, macOS and Linux operating systems.
3838
- It uses
3939
- `TypeScript <https://www.typescriptlang.org/>`__ as the primary language.
40-
- `React <https://reactjs.org/>`__ for user interface.
40+
- `React <https://react.dev/>`__ for user interface.
4141
- `Sequelize <https://sequelize.org/>`__ ORM for database access.
4242
- `Sqlite3 <https://www.sqlite.org/index.html>`__ for managing sqlite database.
4343

docs/source/rst_snippets/centos-note.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@
1717

1818
.. code-block:: bash
1919
20-
./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox
20+
./ScanCode-Workbench-4.0.2-linux-x64/ScanCode-Workbench-4.0.2 --no-sandbox

0 commit comments

Comments
 (0)