Skip to content

README documents no build, run, or protocol details #9

Description

@dmccoystephenson

Problem

README.md is two lines: an # SimpleServer heading and one sentence describing what the server does. Nothing operational is recorded anywhere in the repository.

A reader who wants to run this project has to open the source to learn:

  • how to compile it (no build file exists, so the command is not obvious)
  • which classes are the entry points (SimpleServer.server.ServerApp, SimpleServer.client.ClientApp)
  • which port is used (hardcoded to 2000 in ServerApp.java:9)
  • what the wire format is (key=value, pairs, defined by Message.java)
  • which process values the server accepts (square only, per the switch in Protocol.java:18)
  • what the response keys are (success, answer, reason)

Evidence

All of the above was read out of the source files named. README.md was confirmed to be two lines of content.

Proposed change

A README section recording the build command, the run commands for both entry points, the port, the wire format, and one worked request/response example.

Constraint on the fix

Every command and every quoted output line in such a section must be produced by actually running it before the section lands. This repository has no CI, so an untested paste would go uncontradicted indefinitely. Whoever implements this needs a working JDK available.


This issue was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

drafted by Claude on behalf of Daniel Stephenson

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