BUILDING.md

BUILDING

Back

Guide to download Graphviz graph project, written on the DOT description language from the CthulhuOnIce/SS13-Codebases network.

Table of content

• BUILDING - Table of content
  • Dependencies
    • Windows
    • Ubuntu
  • Building
    • Visual Studio Code (VS Code)
    • Automatic (via scripts)
      • Windows
      • Ubuntu
    • Manual
      • Windows
      • Ubuntu

Dependencies

A program may require one or more other programs to run (the "dependencies").

• Graphviz

Windows

In OS Windows Graphviz app can be installed via:

• Manual install from official website;
• chocolatey (needs to install it first, plus choco.exe needs to be in the PATH environment variable):

CHOCO.EXE install graphviz

Ubuntu

In OS Ubuntu Graphviz app can be installed via two simple commands:

$ sudo apt update -y && sudo apt upgrade -y
$ sudo apt-get install graphviz libgraphviz-dev pkg-config -y

Building

Visual Studio Code (VS Code)

1. Open this repository root folder as project;
2. Press Ctrl+Shift+B to build.

Automatic (via scripts)

Windows

• Run (Double-click of LMB) ./scripts/compile.bat to build (will closes immediately in end).

Ubuntu

• Run ./scripts/compile.sh to build (will closes immediately in end).

Manual

Windows

1. Open bash (cmd.exe) in this project directory;
2. Type next commands:

DOT.EXE -Tsvg builds_all.dot > builds_all.svg
DOT.EXE -Tpng builds_all.dot > tree.png

Where keys is:

1. -T*** - mode (example: -Tsvg, -Tpng);
2. tree before > symbol - input file name;
   • .*** before > symbol - input file name extension (example: .dot);
3. tree after > symbol - output file name;
   • .*** after > symbol - output file name extension (example: .svg, .png) (more).

Graphviz without specify path will output files in current directory.

But you can specify path like in next examle:

DOT.EXE -Tsvg "./src/builds_all.dot" > "./out/builds_all.svg"
DOT.EXE -Tpng "./src/builds_all.dot" > "./out/tree.png"

More information can be founded on the official website.

Ubuntu

1. Open shell in this project directory;
2. Type next commands:

dot -Tsvg builds_all.dot > builds_all.svg
dot -Tpng builds_all.dot > tree.png

Where keys is:

1. -T*** - mode (example: -Tsvg, -Tpng);
2. tree before > symbol - input file name;
   • .*** before > symbol - input file name extension (example: .dot);
3. tree after > symbol - output file name;
   • .*** after > symbol - output file name extension (example: .svg, .png) (more).

Graphviz without specify path will output files in current directory.

But you can specify path like in next examle:

dot -Tsvg ".\\src\\builds_all.dot" > ".\\out\\builds_all.svg"
dot -Tpng ".\\src\\builds_all.dot" > ".\\out\\tree.png"

More information can be founded on the official website.

---