Skip to content

Getting Started

Goal

Set up Chippy locally

Prerequisites

You will need:

  • Git
  • A Java Development Kit (JDK)
  • Network access to fetch Git submodules and Scala dependencies

1. Clone the repository

git clone https://github.com/ucb-substrate/chippy.git
cd chippy

2. Initialize submodules

Chippy depends on these submodules, which we must initialize to build anything

git submodule update --init --recursive

3. Publish all Chippy packages locally

TODO: Use github packages

./mill __.publishLocal

Planned topics

  • TODO: GITHUB PACKAGES!!
  • creating a minimal project
  • running a simple simulation

Next steps

This page will become the main quickstart for new users.