Add to_directory method to relevant object classes

[oam.git] / code / network-generator / CONTRIBUTING.md

diff --git a/code/network-generator/CONTRIBUTING.md b/code/network-generator/CONTRIBUTING.md
index c062074..7a22c5d 100644 (file)
--- a/code/network-generator/CONTRIBUTING.md
+++ b/code/network-generator/CONTRIBUTING.md
@@ -17,18 +17,12 @@ This instructions are for linux base systems. (Linux, MacOS, BSD, etc.)
 ## Prerequisites
 
 ```
-pip install isort
-pip install black
-pip install mypy
-pip install flake8
-pip install pytest
-pip install coverage
-pip install pytest-cov
+sudo apt install python3.10-venv
 ```
 
 ## Setting up your own virtual environment
 
-Run `make virtualenv` to create a virtual environment.
+Run `make virtual_env_4_oam` to create a virtual environment.
 then activate it with `source .venv/bin/activate`.
 
 ## Install the project in develop mode
@@ -91,18 +85,18 @@ This project comes with a `Makefile` that contains a number of useful utility.
 Usage: make <target>
 
 Targets:
-help:             ## Show the help.
-install:          ## Install the project in dev mode.
-fmt:              ## Format code using black & isort.
-lint:             ## Run pep8, black, mypy linters.
-test: lint        ## Run tests and generate coverage report.
-watch:            ## Run tests on every change.
-clean:            ## Clean unused files.
-virtualenv:       ## Create a virtual environment.
-release:          ## Create a new tag for release.
-docs:             ## Build the documentation.
-switch-to-poetry: ## Switch to poetry package manager.
-init:             ## Initialize the project based on an application template.
+help:              ## Show the help.
+install:           ## Install the project in dev mode.
+fmt:               ## Format code using black & isort.
+lint:              ## Run pep8, black, mypy linters.
+test: lint         ## Run tests and generate coverage report.
+watch:             ## Run tests on every change.
+clean:             ## Clean unused files.
+virtual_env_4_oam: ## Create a virtual environment.
+release:           ## Create a new tag for release.
+docs:              ## Build the documentation.
+switch-to-poetry:  ## Switch to poetry package manager.
+init:              ## Initialize the project based on an application template.
 ```
 
 ## Making a new release