Skip to content

[FSTORE-1426][APPEND] Update README with new build instructions #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,24 @@ Create a python 3.10 environment, using a python environment manager of your own

### Step 2

Install the required dependencies to build the documentation in the python environment created in the previous step.

**Note that {PY_ENV} is the path to your python environment.**

```bash
{PY_ENV}/bin/pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python'
```

### Step 3

Clone this repository

```bash
git clone https://github.com/logicalclocks/logicalclocks.github.io.git
```

### Step 4
### Step 3

Go inside the cloned repository
Install the required dependencies to build the documentation in the python environment created in the previous step.

**Note that {PY_ENV} is the path to your python environment.**

```bash
cd logicalclocks.github.io
{PY_ENV}/bin/pip3 install -r requirements-docs.txt
```

### Step 5
### Step 4

Use mkdocs to build the documentation and serve it locally

Expand Down