[GitHub] kohr-h opened a new issue #12839: [Clojure] Readme: "Getting Started" not entirely trivial to follow

[GitBox <gi...@apache.org>]

kohr-h opened a new issue #12839: [Clojure] Readme: "Getting Started" not entirely trivial to follow
URL: https://github.com/apache/incubator-mxnet/issues/12839
 
 
   I mentioned in #12822 that something in the README of the Clojure package was off and intended to fix it. However, now that I read the text in a bit more detail, I have some broader questions that might be good to discuss in advance before I come up with some random change.
   
   The main issue with the current version is that as someone not familiar with the package architecture and just starting out with Clojure (that's me currently), you just follow instructions and don't really have a clue what you're doing. Some of the nagging questions while doing that were:
   
   - If I want to use prebuilt jars, what *exactly* do I have to do?
   
     The fact that some of the instructions I need to follow are under *Cloning the repo and running from source* is rather confusing. I feel that instructions for "From prebuilt jars" and "From source" should be entirely separate.
     Maybe also good to know would be which possible scenarios there exist. If I should guess I would say (1) everything prebuilt jars, (2) all deps from prebuilt jars, but Clojure package from source, (3-infinity) all possible combinations of prebuilt jars and manual builds for deps, most notably the Scala package and MXNet core.
   
   - Prebuilt jars of what?
   
     Certainly too much to mention, I guess, but the biggest ones, the Scala package and the base MXNet package would be worth mentioning.
   
   - Where do the instructions end?
   
     I found it surprising to scroll past the examples to find a header *Build from MXNet Source*, because "source" was mentioned earlier already. Are those two things connected?
     One way to make it clear that there are two entirely separate sets of instructions (are there?) is to make headers **Method 1: Use prebuilt jars** and **Method 2: Build from source**.
   
   - The prebuilt Scala package isn't working (#12822, workaround in place now). Can I build it from source but still use a prebuilt jar for MXNet core?
   
   As I mentioned above, I'm not really familiar with the build infrastructure and the Clojure package architecture, so I wouldn't exactly know what to write as instructions. But equipped with some extra knowledge, I certainly could.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services