Skip to content

Commit 6a81d6e

Browse files
committed
docs: removing upstream readme sections
1 parent 329c1e8 commit 6a81d6e

File tree

1 file changed

+0
-36
lines changed

1 file changed

+0
-36
lines changed

README.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,6 @@ to use the CoMPAS Backend Service to open and save SCL Files and more.
1919

2020
## Contributing
2121

22-
### Building
23-
24-
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.
25-
26-
Once Node.js is installed on your system, you may get started by entering the following lines in your command prompt:
27-
28-
```
29-
git clone https://github.com/openscd/open-scd.git
30-
cd open-scd
31-
npm install
32-
npm start
33-
```
34-
35-
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.
36-
37-
### TypeDoc
38-
39-
This project uses [TypeDoc](https://typedoc.org/) to transform documentation comments in the source code into a rendered HTML document that can be queried and navigated through. If you want to consult the generated documentation for the TypeScript components, mixins, modules and other relevant artifacts of this project, you can [do it here](https://openscd.github.io/doc/).
40-
41-
### Linting & Formatting
42-
43-
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. There are similar plugins available for using [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) from within other IDEs and text editors.
44-
45-
### Scripts
46-
47-
We provide the following `npm` scripts for your convenience:
48-
49-
- `npm start` runs `OpenSCD` for development, reloading on file changes
50-
- `npm test` runs the test suite with Karma
51-
- `npm run lint` runs the linter (fixes problems in your code)
52-
- `npm run format` runs the formatter (formats your code in a unified way)
53-
- `npm run doc` builds HTML documentation into the `doc` directory
54-
- `npm run build` builds a deployable version of the project into the `dist` directory
55-
56-
### Development for CoMPAS OpenSCD
57-
5822
See [Development](DEVELOPMENT.md) for more information about how to build and run CoMPAS OpenSCD locally.
5923

6024
## License

0 commit comments

Comments
 (0)