Re: [chuck-users] FLOSS Manual update

Hi Scott H, Scott W, Spencer, Sorry for the late reply. I've just sent you (Scott H, Scott W) an invite to join and edit the book, let me know if you haven't received anything. Spencer, I think this tool can be really useful, thanks for sharing. I'll give it a look as soon as possible. About what to do next on the FLOSS manual, how would you guys proceed? Cheers, Mario On Mon, 8 Apr 2019 at 00:42, Spencer Salazar wrote:

A few years ago I created ckdoc, intended as an easily update-able reference for chuck built-in libraries, chugins, etc. https://ccrma.stanford.edu/~spencer/ckdoc/

Source code is here: https://github.com/spencersalazar/ckdoc

This included a project to attach documentation strings to every class, public member function, and public member variable in the ChucK source code- meaning that ckdoc generates its reference dynamically from the source code rather than the separately maintained, hand-edited HTML reference that is up on the Princeton/Stanford sites. There are still a few classes that don't have documentation strings which you can see in the reference, but the pull request button is there if anyone wants to help :)

Spencer

On Sun, Apr 7, 2019 at 12:53 PM Scott Hewitt wrote:

...

Hi,

I added a bit a last time and would be willing to do so again.

my user name is witt0191

It would be good to have a list of un documented stuff as crazy as that sounds!

Scott

---------- visit me

http://scotthewitt.co.uk @scotthewitt

http://ablelemon.co.uk

On Sun, 7 Apr 2019 at 15:52, mario buoninfante < mario.buoninfante@gmail.com> wrote:

...

Hi Scott,

That's my second round of updating the FLOSS manual. At the moment I've been adding some missing info (class methods mainly) and also some basic synthesis tutorials that can be useful to get familiar with ChucK.

But now I think a more structured approach is required. I think it's time to do some proper formatting, to better present the info already in there (ie the way class methods are listed varies from chapter to chapter, an updated 'Installation' section is needed - there are still pictures of Win XP!, and so on).

If you want, I would suggest you to join me on flossmanuals.net, so that you can get the rights to edit the book.

Once you've got access, let's have a chat here on the mailing list, so that everybody is up to date, and get organized about what to do next.

Let me know if you have any question.

Cheers,

Mario

On 07/04/2019 15:25, Scott Smallwood wrote:

Mario,

I agree. Case and point: where is info about HID on the princeton site? Not there! (except examples). I think it might be in the PDF, but not the web doc - at least not anywhere I’ve been able to find.

I’m teaching a class with chuck next year, so this resource will be much needed… I’m happy to help out in any way I can…

PS: If the FLOSS manual is meant to be the all-in-one resource, I wonder about including the Chunity stuff??

—ss

[ - ] Scott Smallwood http://www.scott-smallwood.com - Associate Professor - University of Alberta [ - ]

On Apr 7, 2019, at 4:37 AM, mario buoninfante < mario.buoninfante@gmail.com> wrote:

Hi,

I just added 2 chapters (and updated an existing one), to the ChucK FLOSS manual (https://en.flossmanuals.net/chuck https://l.facebook.com/l.php?u=https%3A%2F%2Fen.flossmanuals.net%2Fchuck%3Ffbclid%3DIwAR2B-M1MzHPF47tY3F35IL0vf_mNftflXgXhMZ6-Z2r96C8xA7o80ch-veg&h=AT0sIBlGxQUXB0tBfseuLvvdbZQH0gOKWMfULe4FC-OuTeDk7PPu6X219G9uaodxNlvKDuOhmHikkP1ZffTirAP4pgfK_Hu1gejrJQXXkjJKhhNFSI7abUGulljL_JGXDpz-Bd1UQiXOHpg ).

- Array Object Functions - String Object Functions - Other Objects Reference (added FileIO and SeriaIO)

There's still 'some' work to do to make the FLOSS manual really comprehensive, but we'll eventually get there Next step would probably be a bit of text formatting. Especially in the various 'reference' sections, there are too many 'styles'. Just a quick note about the FLOSS manual and ChucK documentation in general. What I always found difficult (especially at the begin of my adventure with ChucK), was the fact the the documentation wasn't centralized. There are plenty of places on the internet where you can find bits and bops, but none is really comprehensive (some are outdated, some just incomplete, and so on). I believe ChucK is now mature enough and needs a fully comprehensive (and official) documentation. The FLOSS manual could help with that (my personal opinion, open for discussions :) ). Wouldn't be easier if there was THE place where all the documentation is? Looking forward to hearing from you. In the meanwhile, give me a shout if you wanna help with the FLOSS manual, there's still plenty to do :P

Cheers, Mario

-- Electronic Musician, Creative Coder, QA Engineerhttps://vimeo.com/creativecodingsalernohttp://mbuoninfante.tumblr.com/https:...

_______________________________________________ chuck-users mailing list chuck-users@lists.cs.princeton.edu https://lists.cs.princeton.edu/mailman/listinfo/chuck-users

_______________________________________________ chuck-users mailing listchuck-users@lists.cs.princeton.eduhttps://lists.cs.princeton.edu/mailman/listinfo/chuck-users

-- Electronic Musician, Creative Coder, QA Engineerhttps://vimeo.com/creativecodingsalernohttp://mbuoninfante.tumblr.com/https:...

_______________________________________________ chuck-users mailing list chuck-users@lists.cs.princeton.edu https://lists.cs.princeton.edu/mailman/listinfo/chuck-users

_______________________________________________ chuck-users mailing list chuck-users@lists.cs.princeton.edu https://lists.cs.princeton.edu/mailman/listinfo/chuck-users

_______________________________________________ chuck-users mailing list chuck-users@lists.cs.princeton.edu https://lists.cs.princeton.edu/mailman/listinfo/chuck-users