argouml-tigris-org/argouml

Add basic build instructions to the main README.md

mrmowgli opened this issue · 4 comments

Until there is a formal release process, consider adding the basic build instructions to the main README.md file.

Even basic instructions would be helpful, and any tips or tricks to get it working. For example,

  • Minimum Java version (Sun/OpenJDK)
  • Maximum Java version
  • Maven repositories needed
  • Static assets needed
  • Maven build / run / test commands
  • Any changes to HOSTS files needed to offset the Tigris domain changes

Yes, there is some more work before we can get the releases in place. Having some quick instructions in the README.md along these lines would make life simpler primarily for the developers. Please go ahead and push this change with this (to Gerrithub).

We would appreciate this, too. It is hard to get it running without doc as maven doesnt do everything needed.

@stcarrez I have moved your Pull Request as a change in Gerrithub and added some comments there.

The hosts file changes, were they not solved by bf30ff1 and argouml-tigris-org/parentpom@c2e2407 ?