Skip to content

PaimaStudios/paima-engine-docs

Repository files navigation

Paima logo

Getting started with Paima Engine

This repository holds the current developer documentation for Paima Engine, which is accessible on the website.

Everything placed in this repository (apart from images) is also packed in the Paima Engine executable, meaning you can also read them locally via ./paima-engine docs. You can find the Paima Engine code and executable here

Building This Repostiory

Note, the below instructions are for building this repository, and do not relate to Paima Engine.

Installation

$ yarn install

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published