Status

Jump to bottom

Andy Zhang edited this page Jun 18, 2024 · 3 revisions

Status of this project

This document contains all the build badges of Steppable, at a glance.

Develop (Unstable)

Except constant failures of workflows - not safe at all for production.

Main (More stable)

Miscellaneous

Copyright (C) Andy Zhang, 2023-2024. Licensed under the MIT License.

Contents

Introduction

Philosophy

Contributing

Building

Getting the Source - Cloning the repository to your local machine
Build the Project (CMake) - Compiling the source code of Steppable using CMake
Build the Project (build.py) - Compiling the source code of Steppable using build.py

Development

Workflow - How to contribute to this repository
Coding Style (Python) - Style guidelines for Python code in this project
Coding Style (C++) - Style guidelines for CPP code in this project

API Documentation

Directory Structure - The directory structure used by this project.
Using the API - How to use the Steppable API
Supported Platforms

Others

Performance - Some benchmarks of Steppable for reference
Status - Status of Steppable, at a glance

Clone this wiki locally