Skip to content

Sts0mrg0/cables_dev

 
 

Repository files navigation

cables development environment

cables.gl and cables standalone are mainly developed by undev, with contributions by the cables community and support by various other parties and projects.

This is the repository that holds the parent directory for cables development. Read up about setting up everything for your to start contributing to cables in the section on "Developing Cables" of the official cables documentation.

If you want to learn more about the tools and processes involved, check our "toolchain" guide.

Structure

cables development is spread across five git-repositories

the current repository is the "root folder" for all cables development, it holds documentation, helper scripts to set up your environment and keep it up to date.

it also contains shared code between the different projects and holds npm commands to run watchers for file changes during development (see below).

the cables repository holds all the core ops of cables, and everything that is needed to run cables patches (in the editor, but also in exported patches).

cables_ui contains all code that makes up the cables editor, the ui. everything that is needed to work on patches on cables.gl and in cables standalone lives in this repository.

the repository to bring all of the above together to have a running version of the cables ui with the cables code and ops. runs (and builds/packs) an electron executable that can be used to create patches locally, or develop on core and ui features on your local machine.

a repository containing all the extensions on cables.gl that are not in the core. it is not needed for local development but will give you a few more ops to work with.

Giving Feedback

Issue Workflow

  • create an issue, pick "Bug report" or "Feature Request" from the templates
  • the issue will be assigned a "new" label
  • we will check on these issues regularly, add them to a milestone and remove the "new" label
  • once we added the feature or fixed the bug in any release (also dev/nightly) we will close the issue
  • stable releases will have a changelog with all the closed issues

Appreciation

Thanks to the cables community and our supporters for making this possible. If you like this project, think about supporting it on patreon.

This project was partly funded through the NGI0 Entrust Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101069594.

More...

About

cables development environment

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.7%
  • Other 0.3%