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

Add Surge pdf manual to repo #74

Closed
wants to merge 2 commits into from
Closed

Add Surge pdf manual to repo #74

wants to merge 2 commits into from

Conversation

esaruoho
Copy link
Collaborator

Now that @baconpaul got an AudioUnit (AU) created with a GUI - I think it's high time this repo have Surge.pdf, right?

@kurasu hope that's fine with you?

Now that we're in this state where @baconpaul has gotten Surge to actually run with a GUI, I think it's time this repo contained Surge.pdf too??
@jarkkojs
Copy link
Collaborator

Prefer not to add binaries to GIT repositories unless that is the last straw. Are there sources available for this. If not, would keep it out of the GIT as we can never update it anyway.

@jarkkojs
Copy link
Collaborator

Better idea would be to redo it in ReStructedText/Sphinx and add a build target for it.

@esaruoho
Copy link
Collaborator Author

@jsakkine what's a ReStructuredText/Sphinx? I guess I could do copypasta work but maybe @kurasu has the originals of this?

@jarkkojs
Copy link
Collaborator

@jarkkojs
Copy link
Collaborator

Could be other options. That is the only that what I'm familiar with because it is used in the Linux kernel.

@jarkkojs
Copy link
Collaborator

"Kernel documentation with Sphinx, part 1: how we got here"
https://lwn.net/Articles/692704/
"Kernel documentation with Sphinx, part 2: how it works"
https://lwn.net/Articles/692705/

@baconpaul
Copy link
Collaborator

I agree we should write docs in a format which is editable in emacs (or vi or whatever) and makes web pages. I was thinking “markdown and pngs in a docs directory” but happy for whatever the doc writer chooses as long as we choose something!

@baconpaul
Copy link
Collaborator

Oh wow hold on; while I agree we should write documentation I didn't understand the pull request. You actually HAVE a PDF of the surge manual.

I think it would be super duper useful to have that in the repo. I thought this was an issue about making it, not a PR to add it. Apologies - lots of issues around.

So while I still agree the source would be better, adding surge.pdf as a binary to a docs folder would be super duper helpful to folks.

@esaruoho
Copy link
Collaborator Author

@baconpaul i found it at http://vemberaudio.se/download/surge.pdf

basically, i think, i could type it up to some markdown format, but would rather not, as it is 38 pages long. but if @kurasu tells us: the original master document does not exist, i can type it up no problem. It'll just take me some time.

I'm mostly interested in there being a reasonably opensourced format for this, so would edge towards markdown. something that we can bake a PDF out of, for sure. as i'd want it to not be only online. i need to dump it onto an iPad for instance. or have it available for offline use as a downloadable PDF.

@esaruoho
Copy link
Collaborator Author

posted a question at #78 - let's hope Claes answers it!

@esaruoho
Copy link
Collaborator Author

merged into #68, closing

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.

3 participants