-
-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Simplify entrypoint #2
Comments
cicirello
added a commit
that referenced
this issue
Jul 15, 2020
Updated the examples README as part of #2
@nnadeau I merged your makefile, and then edited the two READMEs (see the referenced commits) to remove the redundancy. How does it look now? |
|
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When getting started with the repo, the two primary entrypoints are "building the code" and "running examples".
While a java developer will have no problem building with
ant
and understanding why the-cp
flag is needed to run the examples, these are an extra impedance for someone new to the repo.I'd recommend using a
Makefile
as the entrypoint. See #1 for an example. The READMEs will need to be updated as well.Moreover, the two READMEs (README.md and examples/README.md) cite the same way to run the examples. This duplication of instructions can lead to future stale or out-of-sync documentation. Using a Makefile separates the implementation from the documentation.
cc openjournals/joss-reviews#2448
The text was updated successfully, but these errors were encountered: