Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion: How to improve install process and documentation #38

Closed
wants to merge 5 commits into from

Conversation

jxa
Copy link

@jxa jxa commented Jun 16, 2021

Here is a demonstration PR to facilitate the discussion started in #22 . In my opinion it is too difficult to install this library, at least on a mac. A number of recent issues (#8, #28, #30, #36) demonstrate that it is causing frustration.

My suggestion, only partly implemented here, is to use the existing package management systems for both Emacs and SuperCollider to distribute the scel packages.

.sc files are required to be installed in supercollider. If we publish a quark, this can be as easy as executing this on the installation machine:

Quarks.install("https://github.com/jxa/scel");
// This will of course change for the final published version.

The emacs side can be handled with the package manager of the user's choosing. Here's what it looks like in my Doom config:

(package! sclang
  :recipe (:host github
           :repo "jxa/scel"
           :branch "reorg"
           :files ("el/*.el")))

We can publish a melpa package description too, once this is merged to main. Something like:

(sclang
 :fetcher github
 :repo “supercollider/scel”
 :branch “main”
 :files (:defaults “el/*.el"))

This is still a draft because there are open questions / todos, but I wanted to open this up for early feedback and discussion

  • What are the default install locations for the other operating systems?
  • The old readme talks about the emacs extensions being available in site-lisp. I assume that's what the cmake stuff will end up doing? Do we want to keep that in place or deliver future versions of supercollider independently of the emacs extensions?

Some discussion now happening on scsynth.org

@jxa jxa changed the title Discussion: Discussion: How to install sclang-mode and supercollider extensions Jun 16, 2021
@jxa jxa changed the title Discussion: How to install sclang-mode and supercollider extensions Discussion: How to improve install process and documentation Jun 16, 2021
@jxa
Copy link
Author

jxa commented Jul 26, 2021

replaced by #39

@jxa jxa closed this Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant