You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-14Lines changed: 2 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,10 +32,10 @@ To build OpenCOR, you also need a C/C++ toolchain:
32
32
33
33
## Scripts
34
34
35
-
Before doing anything, you need to install all of OpenCOR's dependencies (see the [note](#note) below regarding the optional `:arm` suffix):
35
+
Before doing anything, you need to install all of OpenCOR's dependencies:
36
36
37
37
```bash
38
-
pnpm install[:arm]
38
+
pnpm install
39
39
```
40
40
41
41
Then, you can run a given script:
@@ -47,27 +47,15 @@ pnpm <script>
47
47
where `<script>` is one of the following:
48
48
49
49
-`build`: build OpenCOR;
50
-
-`build:arm`: build OpenCOR for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family);
51
50
-`build:libopencor`: build OpenCOR's JavaScript interface to the C++ bindings of libOpenCOR;
52
-
-`build:libopencor:arm`: build OpenCOR's JavaScript interface to the C++ bindings of libOpenCOR for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family);
53
51
-`build:web`: build OpenCOR's Web app;
54
52
-`clean`: clean OpenCOR's environment;
55
-
-`clean:all`: clean OpenCOR's environment and then prune `pnpm`'s store (the latter is needed when wanting to use both the `install` and `install:arm` scripts);
56
53
-`dev`: start OpenCOR and OpenCOR's Web app in development mode;
57
-
-`dev:arm`: start OpenCOR for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family) and OpenCOR's Web app in development mode;
58
54
-`dev:web`: start OpenCOR's Web app in development mode;
59
55
-`format`: format OpenCOR's code and OpenCOR's Web app's code;
60
56
-`format:check`: check that OpenCOR's code and OpenCOR's Web app's code are properly formatted;
61
-
-`install`: install OpenCOR's dependencies;
62
-
-`install:arm`: install OpenCOR's dependencies for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows)/[Linux](https://en.wikipedia.org/wiki/Linux) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family);
63
57
-`lint`: lint OpenCOR's code and OpenCOR's Web app's code;
64
58
-`package`: (build and) package OpenCOR for the current platform;
65
-
-`package:arm`: (build and) package OpenCOR for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family) for the current platform;
66
59
-`publish:web`: publish OpenCOR's Web app on [npm](https://npmjs.com/);
67
60
-`start`: start OpenCOR in production mode; and
68
-
-`start:arm`: start OpenCOR for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family) in production mode; and
69
61
-`start:web`: start OpenCOR's Web app in production mode.
70
-
71
-
<aname="note" ></a>
72
-
73
-
**Note:** scripts that have an `:arm` suffix are only to be used when wanting to target [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family) or installing on [Linux](https://en.wikipedia.org/wiki/Linux) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family). The corresponding generic scripts only target [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [Intel](https://en.wikipedia.org/wiki/List_of_Intel_processors) (and [Linux](https://en.wikipedia.org/wiki/Linux)/[macOS](https://en.wikipedia.org/wiki/MacOS) on [Intel](https://en.wikipedia.org/wiki/List_of_Intel_processors)/[ARM](https://en.wikipedia.org/wiki/ARM_architecture_family), depending on the operating system and on the C/C++ toolchain).
0 commit comments