Something wicked this way comes
I have finally decided to release Ouija as open source and unless something else happens (like someone deciding to pay me a bunch of money not to release it) it should be out within the next month. At the moment though I am quite unsure about a few things and I am looking for some help. Any feedback regarding these things or anything you think I should know before this would be greatly appreciated.
- What type of license should I be releasing this under?
- How much documentation should I put together before releasing it? (more documentation would mean more time before the release vs documentation being added later potentially by other users)
- Where should I host it? (I’m planning on google code, but if anyone has any other thoughts I’d be glad to hear them)
- At the moment I just have it sitting in the root package in a folder that I link to in my Flash preferences. I did this because Ouija is mainly a bunch of utility functions that are not in classes, so in the root it is as if I just have extra language level functions that I can use without having to import anything. My question is should I change this or should I go down the standard com.SolveEtCoagula.Ouija.blahblahblah type path?
- How does one go about accepting changes from others on a project like this? Do people request access to commit to the repository or should they all funnel through me?
I believe that is all for now. Like I said any help on this would be greatly appreciated. Also if anyone is interested in helping me out just let me know. (if you know AS3 and Scheme quite well, are dying to get your hands on a copy, would be willing to help with documentation and tying up loose ends, and would like to have a large amount of influence of where this whole thing goes, please contact me)
Comments
Have you looked at using GitHub? It would solve all your problems having to do w/ accepting changes from other people and the like.
Since this is new, my guess is that only early adopters and people who really have been dying for this are going to use it. So document how to get started quickly and easily. Those people will be able to figure it out from there. Plus, the more people who try it, the more people will stick with it, and the more feedback you’ll get about what else needs to be documented.
As for license, I was never an expert at that stuff. I would usually look at a project I wanted to be like (in terms of who owns what, who contributes, etc.) and copy what they’re doing.
I’ve got an interpreter project that I’m managing - it’s a port of a Javascript-like scripting engine from AS2 to AS3.
You can look at it at http://kinsmangames.com/beinteractive-scripting-engine-bise-as3-port/ if you want a example of a simple release.
When I did the port, I inherited the MIT license that came with the code, and I don’t have any complaints with it - it just asks for a simple copyright notice, and otherwise lets people use the code freely.
When I wrote the documentation, instead of writing up notes for every class and function I decided to write a “user’s guide” that showed programmers how to install and use the engine in their own projects. I also wrote up a simple demo project, and gave out the source code for it.
As for your other questions, I’d say just go the easy path - call it com.SolveEtCogula.*, put it up on Google Code, and let that be that. If you find a good reason to change, you can always change it later.
Anyway, congratulations - I’m looking forward to seeing it released.
I am definitely excited about the possibilities Ouija offers. I have been learning Scheme/Lisp myself for a little while now, as well as dabbling in bringing its concepts and ideas to other languages I agree with Johnathan Tran regarding documentation. It doesn’t have to be heavy @ the start but definitely enough to get your feet wet. If you have the time releasing a demo application to showcase the utility of the language/framework would be awesome…As far as licenses go…just my two cents but MIT/BSD if you wish to retain copyright and want people to do as they please whether it be commercial or otherwise. versus GPL if you want the code to be released to the community but want to keep more of a handle on how your brainchild grows up..AFAIK all changes must be contributed back to the community…made avail for public consumption
Hi,
I’ve been looking into Flash development lately. I would really love a Lisp that can write SWF files - are you still thinking of releasing this?
I suggest you just throw it up on GitHub as it is with an MIT license and see what happens. GitHub makes it easy to manage patches, etc, and I’m sure you’ll get plenty.
Cheers,
Paul
Hi.
Regarding licensing, I’d definitely go with FreeBSD or MIT. In my view, freer the better, specially since there is some ambiguity regarding GPLed code and Actionscript.
As for the rest, I’d second GitHub. It has a very good interface, makes it easy for people to colaborate.
The more documentation the better of course. But if that is holding your release, don’t wait for it. People interested in Lisp and Actionscript is a tiny, tiny group, and can probably find their way through things. If anything make a quick read me on how to build, get a REPL and a simple program (put a few sprite on stage, have them listen to mouse events, load a few assets).
I haven’t done much AS3 in a while, but I’d be very interested in seeing how running a LISP on the AVM would make my life better.
Oh, and a small thing, I think you can put everything under a ouija.* package.
Best regards
Arthur Debert
Post a comment