Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.6 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.6 KB

Sorse

Canvas for the modern era.



forthebadge standard-readme compliant

Sorse is currently in the middle of a rewrite using JSX over the current api, updates will occur soon!

Sorse is an easy to use canvas wrapper for typescript. It comes with many built in functions and allows you to get running in seconds with our startup guides. It works with almost any library and can be used in tandum with a web UI. For support please visit our discord

git clone sometjing

Table of Contents

Contributing

See the nonextistent contributing file! We love more people to help with this project, and if you have any questions feel free to ask on our discord.

Bugs

If you believe you have found a bug then do the following:

  1. Create a clean install of Sorse.
  2. Attempt to reproduce the bug. Confirm its actually a bug and not a user error.
  3. If you can reproduce it, then file a bug report here. In some cases you may need to keep the repo and publish it to Github so we can see the issue for ourselves.

Feature Requests

Create a feature request here

Install

Installing is pretty simple, all you need to do is download the ZIP and open it in VSCode, make sure you have Node.js and Yarn, then run yarn, yarn build, and yarn start in that order. We'll have more information when we release our first MVP.

Addon-API

PRs accepted (read the contributing section!1!1)

Small note: If editing the Readme, please conform to the standard-readme specification.