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.

Sign up for GitHub

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

Jump to bottom

Include a README #81

Open
Naouak opened this issue Feb 27, 2018 · 2 comments
Open

Include a README #81

Naouak opened this issue Feb 27, 2018 · 2 comments
Assignees
@antecedent

Comments

@Naouak
Copy link

Naouak commented Feb 27, 2018

Please include a readme providing minimum informations about the project, how to install and use it and how to contribute.
@antecedent antecedent self-assigned this Feb 28, 2018
antecedent added a commit that referenced this issue Feb 28, 2018
@antecedent
Begin #81
cbd5398
@dwilbourne
Copy link

Appreciate the README on packagist. Please consider expanding it to include the public API and some additional working examples and more detailed description of abilities and limitations (e.g. you specify monkey patching user-defined functions. Does the package permit monkey-patching system functions, e.g. fopen or fread?). Also please consider adding the README to Github.

@Lewiscowles1986
Copy link

Is this handled via the gh-pages branch and visiting https://antecedent.github.io/patchwork/ (redirects to website)

If so, should this close?

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

@antecedent antecedent

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Naouak @antecedent @Lewiscowles1986 @dwilbourne