{"id":13773472,"url":"https://github.com/supercollider/learn","last_synced_at":"2026-03-12T03:30:17.905Z","repository":{"id":45663673,"uuid":"145462234","full_name":"supercollider/learn","owner":"supercollider","description":"Official SuperCollider tutorial","archived":false,"fork":false,"pushed_at":"2021-04-17T10:27:58.000Z","size":96,"stargazers_count":77,"open_issues_count":3,"forks_count":24,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-04-19T17:22:51.649Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/supercollider.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license/CC-BY-SA-4.0","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-20T19:35:03.000Z","updated_at":"2024-04-09T18:44:16.000Z","dependencies_parsed_at":"2022-08-01T01:39:06.024Z","dependency_job_id":null,"html_url":"https://github.com/supercollider/learn","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Flearn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Flearn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Flearn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Flearn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/supercollider","download_url":"https://codeload.github.com/supercollider/learn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239914933,"owners_count":19717760,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T17:01:16.030Z","updated_at":"2026-03-12T03:30:17.839Z","avatar_url":"https://github.com/supercollider.png","language":null,"funding_links":[],"categories":["Learning resources"],"sub_categories":["Written tutorials"],"readme":"# SuperCollider Tutorials\nThe repository for the official SuperCollider online tutorial and reference information. Currently\nthis is in the early stages of development.\n\n## Get Involved\n\nIf you want to get involved then contact us either on the [SuperCollider Forum][forum] or the\n[SuperCollider Slack][slack] channel. Any level of involvement is fine. If you want to write a\ntutorial by yourself then we won't stop you - equally if all you can do is proof read, or suggest\nresources, that's also helpful.\n\n## Tutorial Standards\n\nDocuments should have a max line length of 100 columns and be written in markdown.\n\nCode should follow the SuperCollider style guidelines here:\nhttps://github.com/supercollider/supercollider/wiki/Code-style-guidelines\n\nWe have provided [additional style guidelines](supercollider-style-guidelines.md) specific to this tutorial.\n\nCookbook entries should address a particular problem that people might run into and show them how\nit can be solved. It is perfectly okay to show multiple solutions, but these _must_ be practical\nsolutions.\n\n## Forking this repository\nIn order to make edits to the tutorials in this repository, you will first need to fork it. Once you make the edits you must then submit pull requests containing those edits back to this repository.\n1. Create a github account [here](https://github.com/join) if necessary\n1. Login to github [here](https://github.com/login)\n1. Navigate to this page\n1. Click the `Fork` link at the top right of the page\n\nGithub will create a fork of this repository in your account. You will now be able to clone it and make changes to it like any other git repository.\n\n## Submitting a pull request\nNow that you have made some changes to your fork, you will want to submit a pull request back to this repository. To do so:\n1. Ensure your changes are committed and pushed to a branch in your fork\n1. Navigate to that branch in your fork in github\n1. Click the `New pull request` button next to the branch name near the top left\n1. Ensure that the `base fork` and `base` drop-downs are set to `supercollider/learn` and `master` respectively\n1. Click the `Create pull request` button\n1. Enter a title and comment\n1. Click the `Create pull request` button\n\nYou will be redirected to the `supercollider/learn` homepage on github. Your pull request has been submitted and will be considered for inclusion in the repository.\n\n## Editing the tutorials\n\n### Requirements\n\nThe tutorials are currently built using [mdBook]. On Windows and Linux you just need to download\nthe binary from their site and update your path so that it points to it. Unfortunately they do not\nhave a download available for OSX. Fortunately building MDBook is super easy (just follow the\ninstructions). If for some reason you are unable to build it - then contact me on [Slack][slack]\nand I'll send you a binary.\n\n### Build\n\n[mdBook] is a clone of the original [gitbook] and uses [markdown]. So long as you're familiar with\n[markdown] then you really shouldn't have any issues as the [mdBook guide] is pretty decent.\n\nCurrently there are four tutorials in the src file. The tutorials are built separately (this will\nchange at some future point). The src code for each book is in ```src/[book-name]```. The html will\nbe generated in a sub-folder of the ```book``` directory in the root folder.\n\n#### Useful commands\n\n+ ```mdbook build``` - Build the tutorial.\n+ ```mdbook build -o``` - Build the tutorial and open it in your default browser.\n+ ```mdbook watch``` - Build the tutorial automatically whenever any of the\n  files are changed.\n+ ```mdbook serve -o``` - Preview the tutorial at ```http:\\\\localhost:3000```\n\n## Document formatting\n\nThe tutorials are written in github's Markdown, which is documented [here](https://guides.github.com/features/mastering-markdown/).\n\n## Licence\n\nAll content in this repository is licensed under a Creative Commons\nAttribution-ShareAlike 4.0 International License.\n\nYou should have received a copy of the license along with this work.  If not,\nsee \u003chttp://creativecommons.org/licenses/by-sa/4.0/\u003e.\n\n[mdBook Guide]: https://rust-lang-nursery.github.io/mdBook/\n[mdBook]: https://github.com/rust-lang-nursery/mdBook\n[forum]: https://scsynth.org/\n[slack]: https://join.slack.com/t/scsynth/shared_invite/enQtMzk3OTY3MzE0MTAyLWY1ZGE1MTJjYmI5NTRkZjFmNjZmNmYxOWI0NDZkNjdkMzdkNjgxNTJhZGVlOTEwYjdjMDY5OWM0ZTA4NWFiOGY\n[gitbook]: https://toolchain.gitbook.com/\n[markdown]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupercollider%2Flearn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupercollider%2Flearn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupercollider%2Flearn/lists"}