Skip to content

Commit

Permalink
Updating README.
Browse files Browse the repository at this point in the history
  • Loading branch information
kaanaksit committed Jan 23, 2024
1 parent ea500d9 commit 54a95d5
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ To learn more about what Odak can do to help your design, experimentation, and d
## Getting Started

### Installing

We encourage users to use virtual environments in their development pipeline when working with or developing odak.
You can simply create and activate a virtual environment by using the following syntax:

```bash
python3 -m venv odak
source odak/bin/activate
```

Once activated, in the first usage, you can install odak using the previous instructions.
To deactivate the virtual environemnt, you can always use `deactivate` command in your terminal.
Once you have an activated virtual environment, please consider following any of the highlighted installation methods below.

For the most recent guidance on installing Odak, please consult [installation documentation](https://kaanaksit.github.io/odak/odak/installation/).
Odak can be installed using [pip](https://pypi.org/project/pip):

Expand All @@ -28,17 +41,6 @@ pip3 install -r requirements.txt
pip3 install -e .
```

We encourage users to use virtual environments in their development pipeline when working with or developing odak.
You can simply create and activate a virtual environment by using the following syntax:

```bash
python3 -m venv odak
source odak/bin/activate
```

Once activated, in the first usage, you can install odak using the previous instructions.
To deactivate the virtual environemnt, you can always use `deactivate` command in your terminal.

### Usage and examples
You can import Odak and start designing your next in Optics, Computer Graphics, or Perception!
We prepared a [documentation](https://kaanaksit.com/odak/) on usage and much more.
Expand Down

0 comments on commit 54a95d5

Please sign in to comment.