Browse Source

Move the development instructions from README.md to a separate file

Miroslav Abrahám 5 months ago
parent
commit
f872651a6c
2 changed files with 38 additions and 41 deletions
  1. 0 41
      README.md
  2. 38 0
      docs/DEVELOPMENT.md

+ 0 - 41
README.md

@@ -123,47 +123,6 @@ Here as well, you are able to provide a custom duration: `runAllZones(600)` (for
 
 ------
 
-## Development
-
-In order to install the development environment, please run the following code:
-
-### Linux
-
-```sh
-python -m venv distro/python-linux
-source distro/python-linux/bin/activate
-pip install nodeenv
-nodeenv --node=16.0.0 --npm=8.1.0 --with-npm distro/nodejs-linux
-deactivate
-
-source distro/nodejs-linux/bin/activate
-npm install axios@1.4.0
-npm install -D @types/node@18.16.8 rimraf@5.0.0 typescript@5.0.4
-deactivate_node
-```
-
-### Windows
-
-```bat
-python -m venv distro/python-windows
-distro\python-windows\Scripts\activate.bat
-pip install nodeenv
-nodeenv --node=16.0.0 --npm=8.1.0 --with-npm distro\nodejs-windows
-distro\python-windows\Scripts\deactivate.bat
-
-distro\nodejs-windows\Scripts\activate.bat
-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
-```
-
-Then to build the module run
-```
-npm run build
-```
-
-------
-
 ## Contributors
 
 * Miroslav Abrahám - Further modifications and fixes of the code

+ 38 - 0
docs/DEVELOPMENT.md

@@ -0,0 +1,38 @@
+# Development environment
+
+In order to set up the development environment, run the following based on the OS used:
+
+## Linux
+
+```sh
+python -m venv distro/python-linux
+source distro/python-linux/bin/activate
+pip install nodeenv
+nodeenv --node=16.0.0 --npm=8.1.0 --with-npm distro/nodejs-linux
+deactivate
+
+source distro/nodejs-linux/bin/activate
+npm install axios@1.4.0
+npm install -D @types/node@18.16.8 rimraf@5.0.0 typescript@5.0.4
+deactivate_node
+```
+
+## Windows
+
+```bat
+python -m venv distro/python-windows
+distro\python-windows\Scripts\activate.bat
+pip install nodeenv
+nodeenv --node=16.0.0 --npm=8.1.0 --with-npm distro\nodejs-windows
+distro\python-windows\Scripts\deactivate.bat
+
+distro\nodejs-windows\Scripts\activate.bat
+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
+```
+
+Then to build the module run
+```
+npm run build
+```