Skip to content

Commit aef0b5a

Browse files
committed
README: added some information about our prerequisites and our scripts.
qwe
1 parent 6951bb4 commit aef0b5a

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,43 @@
11
# OpenCOR
22

33
[OpenCOR](https://opencor.ws/) is a Web-based modelling environment, which can be used to organise, edit, simulate, and analyse [CellML](https://cellml.org/) files. It can be used both as a standalone application (on [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows), [Linux](https://en.wikipedia.org/wiki/Linux), and [macOS](https://en.wikipedia.org/wiki/MacOS)) and on the Web.
4+
5+
## Prerequisites
6+
7+
To build OpenCOR, you need to install [node.js](https://nodejs.org/) and [npm](https://npmjs.com/), which you can do from [here](https://nodejs.org/en/download/package-manager). Then, you need to install [yarn](https://yarnpkg.com/), which you can do by running:
8+
9+
```bash
10+
npm install -g yarn
11+
```
12+
13+
## Scripts
14+
15+
Before doing anything, you need to install all of OpenCOR's dependencies:
16+
17+
```bash
18+
yarn
19+
```
20+
21+
Then, you can run a given script:
22+
23+
```bash
24+
yarn <script>
25+
```
26+
27+
where `<script>` is one of the following:
28+
29+
- `clean`: clean OpenCOR's environment;
30+
- `dev`: start OpenCOR and OpenCOR's Web app in development mode;
31+
- `dev:web`: start OpenCOR's Web app in development mode;
32+
- `format`: format OpenCOR's code and OpenCOR's Web app's code;
33+
- `format:check`: check that OpenCOR's code and OpenCOR's Web app's code are properly formatted;
34+
- `lint`: lint OpenCOR's code and OpenCOR's Web app's code;
35+
- `package`: (build and) package OpenCOR for the current platform;
36+
- `package:linux`: (build and) package OpenCOR for Linux;
37+
- `package:mac`: (build and) package OpenCOR for macOS;
38+
- `package:win`: (build and) package OpenCOR for Windows;
39+
- `publish:web`: publish OpenCOR's Web app on [npm](https://npmjs.com/);
40+
- `start`: start OpenCOR in production mode;
41+
- `start:web`: start OpenCOR's Web app in production mode;
42+
- `typecheck`: type check OpenCOR's code; and
43+
- `typecheck:web`: type check OpenCOR's Web app's code.

0 commit comments

Comments
 (0)