Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated installation note for centos & macos, fixed minor typos in docs #631

Merged
merged 1 commit into from
Mar 8, 2024
Merged

Updated installation note for centos & macos, fixed minor typos in docs #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ Changelog <https://keepachangelog.com/en/1.0.0/>`__
[v4.0.3] - Unreleased
--------------------------

Docs
~~~~~~~~~

- Update macOS installation steps by @OmkarPh in #631


[v4.0.2] - 2024-02-28
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion Release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:)

<!-- # New Contributors -->
Expand Down
10 changes: 10 additions & 0 deletions docs/source/getting-started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://discussions.apple.com/thread/253714860>`__

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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/overview/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Underlying Technology
- 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.
- It uses
- `TypeScript <https://www.typescriptlang.org/>`__ as the primary language.
- `React <https://reactjs.org/>`__ for user interface.
- `React <https://react.dev/>`__ for user interface.
- `Sequelize <https://sequelize.org/>`__ ORM for database access.
- `Sqlite3 <https://www.sqlite.org/index.html>`__ for managing sqlite database.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/rst_snippets/centos-note.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading