From 44ce8a9ccf595df8a1e1406ba6e68c6de7697153 Mon Sep 17 00:00:00 2001 From: Xavier Robin <xavier.robin@unibas.ch> Date: Wed, 21 May 2025 10:57:34 +0200 Subject: [PATCH] doc: add getting started example --- modules/doc/install.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/modules/doc/install.rst b/modules/doc/install.rst index 1b145406..6c531068 100644 --- a/modules/doc/install.rst +++ b/modules/doc/install.rst @@ -404,6 +404,15 @@ or, to start the command-line interpreter: stage/bin/ost +The `ost` executable can run python scripts. For instance we can run the Docker +test script: + +.. code-block:: bash + + stage/bin/ost docker/test_docker.py + +This should produce some output and announce that "OST is working!" + If you repeatedly use OpenStructure, it is recommended to add /path/to/ost/stage/bin to your path. -- GitLab