Skip to content

Commit

Permalink
Updated build docs
Browse files Browse the repository at this point in the history
Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com>
  • Loading branch information
OmkarPh committed Dec 25, 2023
1 parent f62d96a commit 5e93211
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,7 @@ Note: Due to usage of native modules, a build must be done on target platform on
$ npm run publish
```

After building is done, you can find `ScanCode-Workbench` under
`dist/ScanCode-Workbench-<os>-x64-<version>`. Archives (tar.gz and .zip) are
also built.
You can find the executible `ScanCode-Workbench-<version>` inside `out/ScanCode-Workbench-<version>-<os>-<arch>` and distributable archive (.tar.gz or .zip) in `dist/`

## Testing

Expand Down
21 changes: 13 additions & 8 deletions docs/source/contribute/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,29 +66,34 @@ Windows
Release Instructions
====================

You can build a ``dist`` directory and a ``tar/zip`` file containing executable for your platform
by running:
ScanCode Workbench is built using `electron-forge <https://www.electronforge.io/>`__ and
`electron-packager <https://www.npmjs.com/package/electron-packager>`__

You can build the application for your platform using following command:

.. code-block:: bash
npm run publish
After building is done, you can find ScanCode-Workbench under
``dist/ScanCode-Workbench-<os>-<arch>-<version>``.
You can find the executible ``ScanCode-Workbench-<version>`` inside
``out/ScanCode-Workbench-<version>-<os>-<arch>`` and
a distributable archive in ``dist/`` directory.

Archives are also built as:
Archives are built as:
- ``tar.gz`` - Linux / MacOS
- ``.zip`` - Windows

.. Note:: A build for any of the three target platforms must be executed on the targeted platform.
.. Note::
Due to usage of native modules, a build must be done on target platform only.
For example, a linux build must be done on linux machine only.


Building Documentation
======================

Create python environment, make docs


.. code-block:: none
.. code-block:: bash
# Clone this repository
git clone https://github.com/nexB/scancode-workbench.git
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contribute/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Test ABCM functionality using:

.. code-block:: none
.. code-block:: bash
$ npm test
Expand Down

0 comments on commit 5e93211

Please sign in to comment.