From 178ddfa8d38f19cc4fe9879ab732ebfe2a1461c1 Mon Sep 17 00:00:00 2001
From: Stanislav Bogatyrev <stanislav@nspcc.ru>
Date: Tue, 1 Dec 2020 18:03:59 +0300
Subject: [PATCH] Update documentation

Brief descriptions of newly added services and minor README updates.

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
---
 README.md                         | 37 +++++++++++++++++++++++++++++++
 help.mk                           |  2 +-
 services/chain/artifacts.mk       |  1 +
 services/ir/prepare.mk            |  2 +-
 services/morph_chain/artifacts.mk |  1 +
 5 files changed, 41 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 70e19b4..238c6f4 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,14 @@ Tools to set up local NeoFS network and Neo 3 privnet. Devenv, for short.
 ```
 $ make up
 ```
+When all services are up, you need to make GAS deposit for test wallet to be
+able to pay for NeoFS operations. Test wallet is located in `wallet/wallet.json`.
+
+```
+$ make prepare.ir
+Enter account NTrezR3C4X8aMLVg7vozt5wguyNfFhwuFx password >
+Sent invocation transaction fa6ba62bffb04030d303dcc95bda7413e03aa3c7e6ca9c2f999d65db9ec9b82c
+```
 
 You can see the addresses and hostnames of components with `make hosts` command.
 
@@ -29,6 +37,7 @@ $ make hosts
 
 It's recommended to add `make hosts` output to your local `/etc/hosts` file.
 
+
 ## How it's organized
 
 ```
@@ -55,6 +64,34 @@ can comment out services you don't want to start or add your own new services.
 
 You can find more information on each service in `docs` directory.
 
+Maybe you will find the answer for your question in [F.A.Q.](docs/faq.md)
+
+## Notable make targets
+
+`make help` will print the brief description of available targets. Here we
+describe some of them in a more detailed way.
+
+### up
+
+Start all Devenv services.
+
+This target call `pull` to get container images, `get` to download required
+artifacts, `vendor/hosts` to generate hosts file and then starts all services in
+the order defined in `.services` file.
+
+### down
+
+Shutdowns all services. This will destroy all containers and networks. All
+changes made inside containers will be lost.
+
+### hosts
+
+Display addresses and host names for each running service, if available.
+
+### clean
+
+Clean up `vendor` directory.
+
 ## Contributing
 
 Feel free to contribute to this project after reading the [contributing
diff --git a/help.mk b/help.mk
index 441ff0a..ab30ca9 100644
--- a/help.mk
+++ b/help.mk
@@ -8,4 +8,4 @@ help:
 	@echo ''
 	@echo '  Targets:'
 	@echo ''
-	@awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]+ ?:/{ print "   ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort | uniq
\ No newline at end of file
+	@awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9._-]+ ?:/{ print "   ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort -u
diff --git a/services/chain/artifacts.mk b/services/chain/artifacts.mk
index 997484d..5cb9c9b 100644
--- a/services/chain/artifacts.mk
+++ b/services/chain/artifacts.mk
@@ -1,3 +1,4 @@
+# Download privnet chain dump with pre-deployed NeoFS contracts
 get.chain: CHAIN_DUMP_NAME=devenv.dump.
 get.chain: CHAIN_PATH?=
 get.chain:
diff --git a/services/ir/prepare.mk b/services/ir/prepare.mk
index 9433798..00a9253 100644
--- a/services/ir/prepare.mk
+++ b/services/ir/prepare.mk
@@ -1,3 +1,3 @@
-# Deposit GAS from defualt wallet to NeoFS mainnet contract 
+# Deposit GAS from default wallet to NeoFS privnet contract 
 prepare.ir:
 	@./bin/deposit.sh
diff --git a/services/morph_chain/artifacts.mk b/services/morph_chain/artifacts.mk
index f2999a4..de97592 100644
--- a/services/morph_chain/artifacts.mk
+++ b/services/morph_chain/artifacts.mk
@@ -1,3 +1,4 @@
+# Download NeoFS sidechain dump with pre-deployed NeoFS contracts
 get.morph_chain: MORPH_CHAIN_DUMP_NAME=neo.morph.dump.
 get.morph_chain: MORPH_CHAIN_PATH?=
 get.morph_chain: