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

Add Examples section to documentation #1

Open
jimmyfrasche opened this issue Jan 11, 2014 · 0 comments
Open

Add Examples section to documentation #1

jimmyfrasche opened this issue Jan 11, 2014 · 0 comments
Assignees

Comments

@jimmyfrasche
Copy link
Owner

Need at least one example per input mode.

Examples need to take up as few lines as possible, but have complete inputs, outputs, and specifications, while still being easily readable.

Examples should rely on common tools only (other than txt itself).

Copying and pasting the input and specification should produce the same or similar output.

If there are any really good examples that are too big or complex to meet the above criteria an examples/ directory can be created.

@ghost ghost assigned jimmyfrasche Jan 11, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant