Install | Observe

Open a terminal and clone the repository on your local machine :
```
git clone --recurse-submodules https://github.com/tig12/observe
```
Install php (version 8.0 or higher) on your machine.
Install PECL extension "yaml".
On debian-based systems :
```
sudo apt install php-yaml
```
For other systems, see php manual.

Directory structure

The important files and directories are :

observe/
    ├── commands/
    ├── docs/
    ├── src/
    ├── vendor/
    ├── config.yml.dist
    └── run-observe.php

In the rest of this doc, directory observe/ is called the root directory.
All the commands issued to run the program are done from the root directory.

The files you need to know about are :

run-observe.php is the entry point to use the program.
commands/ contains the the commands that you need to edit.
config.yml.dist needs to be copied (see below).

Configuration

Create a file config.yml by copying config.yml.dist :

cp config.yml.dist config.yml

Configuration is only needed for some commands.