Skip to content

Commit 5e93211

Browse files
committed
Updated build docs
Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com>
1 parent f62d96a commit 5e93211

3 files changed

Lines changed: 15 additions & 12 deletions

File tree

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,7 @@ Note: Due to usage of native modules, a build must be done on target platform on
7272
$ npm run publish
7373
```
7474

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

7977
## Testing
8078

docs/source/contribute/building.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,29 +66,34 @@ Windows
6666
Release Instructions
6767
====================
6868

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

7274
.. code-block:: bash
7375
7476
npm run publish
7577
76-
After building is done, you can find ScanCode-Workbench under
77-
``dist/ScanCode-Workbench-<os>-<arch>-<version>``.
78+
You can find the executible ``ScanCode-Workbench-<version>`` inside
79+
``out/ScanCode-Workbench-<version>-<os>-<arch>`` and
80+
a distributable archive in ``dist/`` directory.
7881

79-
Archives are also built as:
82+
Archives are built as:
8083
- ``tar.gz`` - Linux / MacOS
8184
- ``.zip`` - Windows
8285

83-
.. Note:: A build for any of the three target platforms must be executed on the targeted platform.
86+
.. Note::
87+
Due to usage of native modules, a build must be done on target platform only.
88+
For example, a linux build must be done on linux machine only.
89+
8490

8591
Building Documentation
8692
======================
8793

8894
Create python environment, make docs
8995

90-
91-
.. code-block:: none
96+
.. code-block:: bash
9297
9398
# Clone this repository
9499
git clone https://github.com/nexB/scancode-workbench.git

docs/source/contribute/testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Test ABCM functionality using:
66

7-
.. code-block:: none
7+
.. code-block:: bash
88
99
$ npm test
1010

0 commit comments

Comments
 (0)