From 5024c7fc7abae55edbb1ec2027e78cd204fddff2 Mon Sep 17 00:00:00 2001 From: Omkar Phansopkar Date: Sat, 9 Mar 2024 00:56:08 +0530 Subject: [PATCH] Updated installation note for centos & macos, fixed typos Signed-off-by: Omkar Phansopkar --- CHANGELOG.rst | 5 +++++ Release.md | 2 +- docs/source/getting-started/index.rst | 10 ++++++++++ docs/source/overview/index.rst | 2 +- docs/source/rst_snippets/centos-note.rst | 2 +- 5 files changed, 18 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a8c33107..722ba2cc 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -8,6 +8,11 @@ Changelog `__ [v4.0.3] - Unreleased -------------------------- +Docs +~~~~~~~~~ + +- Update macOS installation steps by @OmkarPh in #631 + [v4.0.2] - 2024-02-28 -------------------------- diff --git a/Release.md b/Release.md index a7a4be2e..3f49652a 100644 --- a/Release.md +++ b/Release.md @@ -14,7 +14,7 @@ This v4.0.2 of ScanCode Workbench is compatible with scans from any [ScanCode To ## Framework -- Electorn [v28.1.0](https://releases.electronjs.org/release/v28.1.0) +- Electron [v28.1.0](https://releases.electronjs.org/release/v28.1.0) - Chromium [v120.0.6099.109](https://source.chromium.org/chromium/chromium/src/+/refs/tags/120.0.6099.109:) diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst index 4b7232e0..704c4114 100644 --- a/docs/source/getting-started/index.rst +++ b/docs/source/getting-started/index.rst @@ -16,6 +16,16 @@ Download and Install On Windows 10, for example, the executable will be named `ScanCode-Workbench-4.0.1.exe`. +.. Note:: + Browsers on MacOS add a ``com.apple.quarantine`` extended attribute to downloaded apps. + 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 `__ + + Delete the attribute using ``xattr`` utility before running the app for first time: + + .. code-block:: bash + + xattr -d com.apple.quarantine ~/Downloads/ScanCode-Workbench-4.0.2-darwin-arm64/ScanCode-Workbench-4.0.2.app + .. include:: ../rst_snippets/centos-note.rst - If you're interested in digging into the code, you can also use ScanCode Workbench by cloning diff --git a/docs/source/overview/index.rst b/docs/source/overview/index.rst index cee2cc09..bdc2fb1d 100644 --- a/docs/source/overview/index.rst +++ b/docs/source/overview/index.rst @@ -37,7 +37,7 @@ Underlying Technology - ScanCode Workbench is a cross-platform application built using the `Electron `__ framework that works on Windows, macOS and Linux operating systems. - It uses - `TypeScript `__ as the primary language. - - `React `__ for user interface. + - `React `__ for user interface. - `Sequelize `__ ORM for database access. - `Sqlite3 `__ for managing sqlite database. diff --git a/docs/source/rst_snippets/centos-note.rst b/docs/source/rst_snippets/centos-note.rst index 9a0629b6..c9d25d15 100644 --- a/docs/source/rst_snippets/centos-note.rst +++ b/docs/source/rst_snippets/centos-note.rst @@ -17,4 +17,4 @@ .. code-block:: bash - ./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox + ./ScanCode-Workbench-4.0.2-linux-x64/ScanCode-Workbench-4.0.2 --no-sandbox