Skip to content

Commit

Permalink
add some icons to getting started document
Browse files Browse the repository at this point in the history
  • Loading branch information
goFrendiAsgard committed Dec 13, 2023
1 parent 30564d6 commit 3a9b61d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
Binary file added docs/_images/emoji/building_construction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 18 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,28 @@ bm9uLWNyZWRlbnRpYWwtc3RyaW5n
To run again: zrb base64 encode --text "non-credential-string"
```

> __📝 NOTE:__ If you need to disable prompt entirely, you can set `ZRB_SHOW_PROMPT` to `0` or `false`. Please refer to [configuration section](./configurations.md) for more information.
> __📝 NOTE:__ You can disable the interactive mode by setting `ZRB_SHOW_PROMPT` to `0` or `false`. Please refer to [configuration section](./configurations.md) for more information.
>
> When prompts are disabled, Zrb will automatically use task-input's default values.
> When prompts are disabled, Zrb will automatically use task-parameter's default values.
That's it. That's all you need to know to work with Zrb.

In the rest of this section, you will learn about Zrb project and how to make your own Zrb Tasks.

# Creating a project

<div align="center">
<img src="_images/emoji/building_construction.png">
<p>
<sub>
A project is like a fridge light; it only works when you open it to check.
</sub>
</p>
</div>

As a software engineer (or anyone), you probably need to work on multiple things simultaneously.


To make things more manageable, you must put all related resources and task definitions under a `project`. A project is a directory containing `zrb_init.py`.

You can create a project manually or use Zrb's built-in task to generate the project. Suppose you want to create a project named `my-project`. You can do so by invoking the following command:
Expand Down

0 comments on commit 3a9b61d

Please sign in to comment.