Przeglądaj źródła

Update the development instructions

Miroslav Abrahám 5 miesięcy temu
rodzic
commit
b618349852
1 zmienionych plików z 9 dodań i 4 usunięć
  1. 9 4
      docs/DEVELOPMENT.md

+ 9 - 4
docs/DEVELOPMENT.md

@@ -1,8 +1,10 @@
-# Development environment
+# Development
+
+## Environment
 
 In order to set up the development environment, run the following based on the OS used:
 
-## Linux
+### Linux
 
 ```sh
 python -m venv distro/python-linux
@@ -17,7 +19,7 @@ npm install -D @types/node@18.16.8 rimraf@5.0.0 typescript@5.0.4
 deactivate_node
 ```
 
-## Windows
+### Windows
 
 ```bat
 python -m venv distro/python-windows
@@ -31,8 +33,11 @@ npm install axios@1.4.0
 npm install -D @types/node@18.16.8 rimraf@5.0.0 typescript@5.0.4
 distro\nodejs-windows\Scripts\deactivate.bat
 ```
+## Building
 
-Then to build the module run
+To build the module run
 ```
 npm run build
 ```
+
+There are other development commands specified in the ```package.json``` file.