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

Update README file #1

Closed
end2endzone opened this issue Nov 21, 2017 · 1 comment
Closed

Update README file #1

end2endzone opened this issue Nov 21, 2017 · 1 comment
Milestone

Comments

@end2endzone
Copy link
Owner

end2endzone commented Nov 21, 2017

  • Update the USAGE section with a preformatted listing. Copy & Paste the output of the application.
  • Remove section HISTORY OF CHANGES
  • Rewrite the CODE SAMPLE section:
    • Rename to Example with sub items called:
      • Input File
      • Command
      • Output
      • Using
    • Show an example of how to use the generated code: print the original filename, size and maybe content ?
  • Add a section that explains how to build the code.
@end2endzone
Copy link
Owner Author

  • Add a section that explains how to build the code
    • Supported compilors/IDE
    • Instructions
    • External library requirements

@end2endzone end2endzone added this to the 1.4 milestone Dec 13, 2017
end2endzone added a commit that referenced this issue Dec 13, 2017
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