-
Notifications
You must be signed in to change notification settings - Fork 1
Getting the Source
ELO edited this page May 20, 2024
·
3 revisions
Steppable is hosted on GitHub. You may clone the repository to get the source code.
$ git clone https://github.com/ZCG-coder/Steppable.git
Cloning into Steppable
...
You may also work on the cloud using GitHub Codespaces.
The development work of Steppable is done in the develop
branch. It is not recommended to use the develop branch for production, but nevertheless it is a good place to see the latest features and bug fixes.
The main
branch is the stable branch. It is recommended to use this branch for production. Currently, except for
merging from develop
and some small changes, no new features are added to this branch.
You can easily switch between branches by using the git checkout
command.
$ git checkout develop
Switched to branch 'develop'
Your branch is up to date with 'origin/develop'.
or switch back to the main
branch:
$ git checkout main
Switched to branch 'main'
Your branch is up to date with 'origin/main'.
Copyright (C) Andy Zhang, 2023-2024. Licensed under the MIT License.
- 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
- 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
- Directory Structure - The directory structure used by this project.
- Using the API - How to use the Steppable API
- Supported Platforms
- Performance - Some benchmarks of Steppable for reference
- Status - Status of Steppable, at a glance