README.md

Welcome to the ZenML VSCode Quickstart 👋

Introduction

This repository is home to the ZenML VS Code Quickstart. The quickstart is a VS Code extension that will guide you through getting started with ZenML.

Running in GitHub Codespaces

To run this extension directly in GitHub Codespaces, follow these steps:

1. Click on the "Code" button and select "Open with Codespaces".
2. Once the Codespace is ready (This will take a few minutes), the extension will automatically load within your development environment.

Running Locally

To run this extension locally, follow these steps:

Step 1: Clone the Repository

Clone the repository to your local machine

Step 2: Install Dependencies

• Visual Studio Code
• Docker
• Dev Containers Extension

Step 3: Load the Extension in VS Code

1. Open Visual Studio Code.
2. You should be prompted to open the project in a devcontainer if you have the Dev Containers extension installed. If not, open the project by selecting "Dev Containers: Reopen in Container" from the VS Code command palette.
3. Once the container is built (will take a few minutes, depending on your network connection and hardware) and prerequisites are installed the extension will open in the Dev Container.

Usage

Once the extension is loaded, follow the tutorial to learn how to use ZenML!

Contributing

If you're interested in contributing, please head over to the development repository here.