Improve install instructions #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When I used Scala 2.7, I got a compiler error "not found: value math." As far as I can tell, this is because Scala 2.7 doesn't include a scala.math package (http://www.scala-lang.org/api/2.7.7/). I tried Scala 2.11.7 instead, and that worked fine.
I think this is a reference to the mysql-connector-java library, a jar for which is already part of the repo. (Technically, it's bad to have jars in repos, but we'll solve that problem another time.)
The installation process modified the jar, so it seems like this is an artifact particular to each person's development environment, not something that should be checked in.
We also clean up exports.sh a bit so it's easy to tell what needs customizing for new environments vs. what is supposed to work as-is. These are hopefully more up-to-date and reasonable defaults for a developer on OS X, and for developers not on OS X, hopefully the cleanup helps clarify what likely needs customization. One of the changes to default values is to use the scala-library.jar within the given installation of Scala, not the repo's scala-library.jar. I don't know much about Scala, but it seems like a better default to make SCALA, SCALA_HOME, and SCALA_LIBRARY_JAR all match instead of SCALA_LIBRARY_JAR being a special snowflake that's checked into the repo.
The bin/exports.sh script now advises developers to use the scala-library.jar within their local installation of Scala.
igorkofman
added a commit
that referenced
this pull request
Aug 20, 2015
Improve install instructions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt to improve the setup instructions in INSTALL.
Each commit contains an explanation in the commit message.
The new instructions are pretty biased towards development on
OS X. Sorry, everybody else. I added some comments that
hopefully indicate what likely needs tweaking if you the defaults
don't work for you.
One problem remains—the app server spits out this error a bunch:
It doesn't seem to interfere with use of the app, and it was happening
even before I made all these changes. Not sure if it's particular to my
setup or if the instructions are missing a step. Suggestions welcome!
@igorkofman