aboutsummaryrefslogtreecommitdiff
path: root/content/en/docs/Tutorials/tutorial-1.md
diff options
context:
space:
mode:
authorDimitri Staessens <dimitri@ouroboros.rocks>2023-07-28 10:12:59 +0200
committerDimitri Staessens <dimitri@ouroboros.rocks>2023-07-28 10:12:59 +0200
commit2c8b06e6aab423cfc50ba02d9ddc661839a6d22b (patch)
treea899f13e81999331bdcef05929c714ec159a3048 /content/en/docs/Tutorials/tutorial-1.md
parentccb15ed449294de7ad9383d46a24cc87b270d21d (diff)
downloadwebsite-2c8b06e6aab423cfc50ba02d9ddc661839a6d22b.tar.gz
website-2c8b06e6aab423cfc50ba02d9ddc661839a6d22b.zip
docs: Update tutorial-1
Diffstat (limited to 'content/en/docs/Tutorials/tutorial-1.md')
-rw-r--r--content/en/docs/Tutorials/tutorial-1.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/content/en/docs/Tutorials/tutorial-1.md b/content/en/docs/Tutorials/tutorial-1.md
index d3d24c0..2e98809 100644
--- a/content/en/docs/Tutorials/tutorial-1.md
+++ b/content/en/docs/Tutorials/tutorial-1.md
@@ -13,8 +13,12 @@ This tutorial runs through the basics of Ouroboros. Here, we will see
the general use of two core components of Ouroboros, the IPC Resource
Manager daemon (IRMd) and an IPC Process (IPCP).
-{{<figure width="50%" src="/docs/tutorials/ouroboros_tut1_overview.png">}}
+It is recommended to use a Debug build for this tutorial to show extra
+IRMd output. To do this, compile with the CMAKE_BUILD_TYPE set to
+"Debug". For a full list of build options and how to activate them, see
+[here](/docs/reference/compopt/).
+{{<figure width="50%" src="/docs/tutorials/ouroboros_tut1_overview.png">}}
We will start the IRMd, create a local IPCP, start a ping server and
connect a client. This will involve **binding (1)** that server to a
@@ -65,13 +69,21 @@ $ oping --listen
Ouroboros ping server started.
```
-The IRMd will notice that an oping server with pid 10539 has started:
+The IRMd will notice that an oping server has started. In our case it has pid 2337, but this will be different on your system:
```bash
-==02301== irmd(DB): New instance (10539) of oping added.
+==02301== irmd(DB): New instance (2337) of oping added.
==02301== irmd(DB): This process accepts flows for:
```
+If you are not running a debug build, you won't see this output and will
+have to look for the pid of the process using a linux command such as ps.
+
+```
+$ ps ax | grep oping
+ 2337 pts/4 Sl+ 0:00 oping --listen
+```
+
The server application is not yet reachable by clients. Next we will
bind the server to a name and register that name in the
"local_layer". The name for the server can be chosen at will, let's