Skip to content

Commit

Permalink
Updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Itz-Agasta committed Feb 17, 2025
1 parent 32d6ab1 commit fcd0477
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,24 +118,29 @@ ethos
git clone https://github.com//Itz-Agasta/ethos.git
cd ethos
```
2. **Set Up a Virtual Environment:**
2. **Install Poetry:**

```bash
python -m venv .venv
source .venv/bin/activate # For MacOS/Linux
.venv\Scripts\activate # For Windows
pipx install poetry
```

3. **Install Dependencies:**
> **Note:** It is recommended to use `pipx` for installing Poetry, but you can also use `pip` if `pipx` is not available. For more information, please refer to the [official documentation](https://python-poetry.org/docs/).
3. **Configure Poetry to Create Virtual Environment in Project Root:**

```sh
poetry config virtualenvs.in-project true
```

4. **Install Dependencies:**
```bash
pip install -r requirements.txt
poetry install
```
4. **Setup the .env file:** see the `.env.example` for reference and create a `.env` file in the root.
5. **Setup the .env file:** see the `.env.example` for reference and create a `.env` file in the root.

5. **Start the application:**
6. **Start the application:**
```bash
python3 main.py #for linux/macOS
python main.py #for windows
poetry run python ethos/main.py
```

### For Distribution:
Expand All @@ -144,12 +149,8 @@ Coming Soon

## Usage:



https://github.com/user-attachments/assets/e46a7585-ccf1-4e30-bc20-3c48b0767969



### Basic Commands

```bash
Expand Down
2 changes: 0 additions & 2 deletions ethos/main.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@

########################
# Entry point of Ethos #
########################

import os
import sys
#sys.path.append(os.getcwd())

from ethos.ui import ui

Expand Down

0 comments on commit fcd0477

Please sign in to comment.