Skip to content
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

Closed
engnadeau opened this issue Jul 15, 2020 · 2 comments · Fixed by #10
Closed

Simplify entrypoint #2

engnadeau opened this issue Jul 15, 2020 · 2 comments · Fixed by #10

Comments

@engnadeau
Copy link
Contributor

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

cicirello added a commit that referenced this issue Jul 15, 2020
Updated the examples README as part of #2
cicirello added a commit that referenced this issue Jul 15, 2020
Updated the readme for issue #2
@cicirello
Copy link
Owner

@nnadeau I merged your makefile, and then edited the two READMEs (see the referenced commits) to remove the redundancy. How does it look now?

@engnadeau
Copy link
Contributor Author

@cicirello

  • with a Makefile, a user should just need to call make examples to run all examples. This avoids:

Just replace org.cicirello.examples.chipsnsalsa.BitVectorExample in the above with the example program of your [..]

  • Modern software development calls for protecting your master branch and using Pull Requests (PR) for all changes. The issue will then be closed by the PR. You can protect master by going to https://github.com/nnadeau/Chips-n-Salsa/settings/branches and add master as a protected branch

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants