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
+28-6Lines changed: 28 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,41 @@ Open Substation Communication Designer is an editor for SCL files as described i
10
10
11
11
## Installation
12
12
13
+
In order to install OpenSCD on your local device (only for you), simply visit [openscd.github.io](https://openscd.github.io), click the "Install OpenSCD" button in your address bar (Chrome or Edge on desktop) or click the "Add OpenSCD to home screen" notification in any mobile browser.
14
+
15
+
In order to install your own instance of OpenSCD on your own webserver (e.g. on your company intranet), simply download [our latest release](https://github.com/openscd/open-scd/releases/latest) (`open-scd.zip` or `open-scd.tar.gz`) and extract the archive contents into the "webroot" directory of your web server.
16
+
17
+
If you don't have your own webserver but still want your own version of OpenSCD hosted locally (e.g. on a system without an internet connection), you can [use a browser plugin that acts as a local webserver](https://github.com/openscd/open-scd/wiki/Install-OpenSCD#offline) (only for you) instead.
18
+
19
+
## Contributing
20
+
21
+
### Building
22
+
23
+
If you want to build OpenSCD yourself in order to make some changes to your local installation or to contribute to the project, you may first want to install [Node.js](https://nodejs.org/) in order to be able to use our local development setup.
24
+
25
+
Once Node.js is installed on your system, you may get started by entering the following lines in your command prompt:
26
+
13
27
```
14
28
git clone https://github.com/openscd/open-scd.git
15
29
cd open-scd
16
30
npm install
17
31
npm start
18
32
```
19
33
20
-
## Scripts
34
+
This will start a local development server and open a browser window which will automatically be reloaded as soon as you save any changes to your local source code files.
35
+
36
+
If you use VSCode to develop, we recommend you install and use the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extensions in order to automatically lint and format your code as you edit it.
37
+
38
+
### Scripts
39
+
40
+
We provide the following `npm` scripts for your convenience:
21
41
22
-
-`start` runs `OpenSCD` for development, reloading on file changes
23
-
-`test` runs the test suite with Karma
24
-
-`lint` runs the linter
25
-
-`doc` builds markdown documentation in the `doc` directory
42
+
-`npm start` runs `OpenSCD` for development, reloading on file changes
43
+
-`npm test` runs the test suite with Karma
44
+
-`npm run lint` runs the linter (fixes problems in your code)
45
+
-`npm run format` runs the formatter (formats your code in a unified way)
46
+
-`npm run doc` builds HTML documentation into the `doc` directory
47
+
-`npm run build` builds a deployable version of the project into the `dist` directory
26
48
27
49
## License
28
50
@@ -31,6 +53,6 @@ distributed under their [end user license agreement](CC-EULA.pdf).
31
53
32
54
This project is licensed under the [Apache License 2.0](LICENSE.md).
0 commit comments