Documentation Convention
Parts of this documentation and the tutorials are run from the command-line interface (CLI) environment, e.g., via Terminal in Linux/macOS, or via Anaconda in Windows. There will be examples of commands you need to type as inputs and text that PeekingDuck will display as outputs. The input commands can be dependent on the current folder where they are typed.
The following text color scheme is used to illustrate these different contexts:
Color |
Context |
Example |
|---|---|---|
Blue |
Current folder |
[~user/src] |
Green |
User input: what you type in |
> peekingduck --version |
Black |
PeekingDuck’s output |
peekingduck, version v1.2.0 |
The command prompt is assumed to be the symbol >,
your home directory is assumed to be ~user,
and the symbol ⏎ means to press the <Enter> key.
Putting it altogether, a sample terminal session looks like this:
Terminal Session