Skip to content

Commit

Permalink
update getting-started
Browse files Browse the repository at this point in the history
  • Loading branch information
goFrendiAsgard committed Dec 13, 2023
1 parent 8d11164 commit 8f8a608
Showing 1 changed file with 0 additions and 39 deletions.
39 changes: 0 additions & 39 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,45 +341,6 @@ source project.sh

Anytime you start working on your project, you should load `project.sh`.



## Activating Virtual Environment

> __📝 NOTE:__ Using virtual environment is not required, but highly recommended.
A virtual environment encapsulates your project pip packages from other projects, ensuring better independence and reproducibility.

### Activating Virtual Environment On A Generated Project

If you generate the project by invoking `zrb project create`, you can create/activate the virtual environment by running the following command:

```bash
source project.sh
```

The command will activate the project's virtual environment and install the necessary pip packages.

You should run the command every time you start working on the project.

### Activating Virtual Environment On A Manually Created Project

If you create the project manually (i.e., by creating `zrb_init.py`), you also need to make a virtual environment for your project. Creating a virtual environment is necessary if you work with non-standard Python libraries.

To create a virtual environment, you can invoke the following command:

```bash
python -m venv .venv
```

Once you make the virtual environment, you can activate it by invoking the following command:

```bash
source .venv/bin/activate
```

You should activate the virtual environment whenever you start working on the project.


# Creating a Task

A task is the smallest unit of job definition. You can link your tasks together to form a more complex workflow.
Expand Down

0 comments on commit 8f8a608

Please sign in to comment.