Updated documentation

README.md

@@ -1,6 +1,5 @@
 Wakurtosis
 =====================
-
 Starting version for Waku network simulations (https://github.com/waku-org/pm/issues/2)
 
 More info about Kurtosis: https://docs.kurtosis.com/
@@ -9,7 +8,7 @@ More info about Kurtosis: https://docs.kurtosis.com/
 
 #### Before using this repository note that: 
 
-- **You are using Kurtosis version 0.70.2**. This is important, as they are working on it and changes can be huge depending on different versions. You can find all Kurtosis versions [here](https://github.com/kurtosis-tech/kurtosis-cli-release-artifacts/releases).
+- **You are using Kurtosis version 0.77.0**. This is important, as they are working on it and changes can be huge depending on different versions. You can find all Kurtosis versions [here](https://github.com/kurtosis-tech/kurtosis-cli-release-artifacts/releases).
 - The topology files that will be used by default are defined in `config/topology_generated/`. This topology is created with the [gennet](gennet-module/Readme.md) module.
 - Kurtosis can set up services in a parallel manner, defined in the `config.json` file (see below).
 - Only `kurtosis` and `docker` are needed to run this.
@@ -18,11 +17,13 @@ More info about Kurtosis: https://docs.kurtosis.com/
 
 From the root of the repo run:
 
-`sh ./run.sh` 
+`./build.sh`
 
-This will load the default configuration file **./config/config.json**. You can also specify a different .json config file and its location with:
+`./run.sh <measurement_infra> [enclave_name] [config_file]` 
 
-`sh ./run.sh ./config/config.json`
+There are 4 different measurements: `cadvisor`, `dstats`, `host-proc`, `container-proc`. The other parameters are optional.
+
+By default, the enclave name is `wakurtosis` and the config file is in `config/config.json`. 
 
 #### JSON main configuration file options
 
@@ -30,34 +31,11 @@ These are arguments that can be modified:
 
 - _prng_seed_: int. Seed to reproduce results.
 - _enclave_name_: string. Default: **wakurtosis**. Defines the name of the Kurtosis enclave being created.
-- _topology_file_: string. Default: **waku_test_topology_small.json**. If defines the network topology that will be created.
+- _topology_path_: string. Topology information that will be read.
 - _jobs_: int. Defines how many services will be instantiated at the same time.
+- _interconnect_nodes_: It allows to skip the interconnection phase of the topology.
 - _interconnection_batch_: int. If nodes are being connected by a given topology, this tells kurtosis how many connections will try to set up in the same node at a time. Used to avoid timeouts if a node has a lot of connections.
 
-- [WLS](wls-module/README.md) module configuration
 - [Gennet](gennet-module/Readme.md) module configuration
+- [WLS](wls-module/README.md) module configuration
 
-#### What will happen
-
-Kurtosis will automatically add one node as container inside the enclave. The way that nodes are interconnected is given by the topology.
-The configuration of each node is given by the configuration file. 
-
-Once all nodes are ready, prometheus and grafana will be set up and connected to all nodes.
-
-Once all nodes have been interconnected the simulation starts and will inject traffic into the network following the parameters specified in the configuration file.
-
-#### Check Prometheus+Grafana+Logs
-
-- Simulation log:
-
-'kurtosis service logs wakurtosis $(kurtosis enclave inspect <enclave-name> | grep wls- | awk '{print $1}')'
-
-- Grafana server:
-
-To display the IP address and Port of the Grafana server on your local machine run:
-
-'kurtosis enclave inspect <enclave-name> | grep grafana- | awk '{print $6}'
-
-Remember that by default <enclave-name> is 'wakurtosis'.
-
-Please, any improvements/bugs that you see, create an issue, and we will work on it.