Skip to content

Commit 0e7ced4

Browse files
authored
docs: clarify build dependencies and scripts
1 parent 1850dfa commit 0e7ced4

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,41 @@ Open Substation Communication Designer is an editor for SCL files as described i
1010
1111
## Installation
1212

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+
1327
```
1428
git clone https://github.com/openscd/open-scd.git
1529
cd open-scd
1630
npm install
1731
npm start
1832
```
1933

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:
2141

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
2648

2749
## License
2850

@@ -31,6 +53,6 @@ distributed under their [end user license agreement](CC-EULA.pdf).
3153

3254
This project is licensed under the [Apache License 2.0](LICENSE.md).
3355

34-
© 2020-2021 OMICRON electronics GmbH
56+
© 2020-2022 OMICRON electronics GmbH
3557

3658
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd?ref=badge_large)

0 commit comments

Comments
 (0)