/MementoEmbed

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

Create developer and non-Docker installation documentation #119

Closed
shawnmjones opened this Issue Aug 15, 2018 · 0 comments

Comments

Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
1 participant
@shawnmjones
@shawnmjones
Collaborator

shawnmjones commented Aug 15, 2018

Based on feedback from @machawk1 in #105, I realized that starting developer documentation for MementoEmbed is nonexistent. At a minimum, the following must exist in the README and ReadTheDocs:

  • how to install MementoEmbed locally
  • how to execute tests
  • the intention of the different directories/files once the repo is cloned as is standard for many open source projects

This issue is not calling for full documentation of all MementoEmbed classes and functions. It is just to provide enough information for a user to install MementoEmbed locally and perform development and testing as I am already doing with the product.

@shawnmjones shawnmjones added the enhancement label Aug 15, 2018

@shawnmjones shawnmjones changed the title from Create developer and non-Docker documentation to Create developer and non-Docker installation documentation Aug 15, 2018

shawnmjones added a commit that referenced this issue Aug 20, 2018

@shawnmjones
Work for #119, updating README to provide better front-facing install… 
…ation and test information
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
fff7bc4

@shawnmjones shawnmjones closed this in 8314ce5 Aug 20, 2018

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