search

tweag / sparkle

Haskell on Apache Spark.
BSD 3-Clause "New" or "Revised" License
447 stars 30 forks source link

The README doesn't explain how sparkle works #52

Closed alexanderkjeldaas closed 8 years ago

alexanderkjeldaas commented 8 years ago

I think the README, at the very start, should explain how sparkle works.

It makes it possible to build a jar file that is executed on spark, but how is this done? Is haskell code compiled to javascript, interpreted through an intercal implementation of javascript in the JVM? Is it compiled to native code called through JNI?

How does it work? A paragraph or a few lines would help a lot.

mboes commented 8 years ago

I think the first thing a user wants to see is what Sparkle can do for her/him, not how it does it. Though an explanation of how things work under the hood would certainly be useful in a later section / separate page. We currently say that Sparkle is a library for doing distributed computing using Spark under the hood. And point to this blog post for the full version. As explained there, it calls native code via JNI. Perhaps propose to a PR that cribs the info that you'd want to see?

alexanderkjeldaas commented 8 years ago

Thanks. Great fix. :-)