Skip to content

Documentation #2

@rweigel

Description

@rweigel

Can you add to README.md instructions for compiling and testing a simple application that uses the code, e.g.

git clone https://github.com/hapi-server/client-java.git
cd client-java; javacc demo.java # or ant ...
java -jar demo.jar # Gets a dataset and reports to stdout metadata and numbers

You could also provide an example using the pre-compiled jar file.

I'd also put the WorkingWith* files in README.md as they are important and useful and the existing README.md will be short.

I'm not sure about putting Netbeans-specific stuff in there. Do the majority of Java developers use Netbeans? Do you need Netbeans to to compile and use? I generally keep my Emacs and Sublime-related project configuration files out of repositories.

Is it more common to have a bin rather than store directory? Not sure what is used in java world.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions