Skip to content

Create reasonably minimum amount of documentation #3

Description

@boamaod

The minimal documentation should probably explain:

  • The basic rationale, scope and uses for the project;
  • Using the example web service (explain the configuration properties);
  • Cautions/instructions for running in practise (real elections, hacking contests etc);
  • Running your own instance and modifying the code.

This should be more than enough for the code release... Wiki, readme or something else?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions