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

update documentation #39

Open
andiempettJISC opened this issue Jul 28, 2017 · 1 comment
Open

update documentation #39

andiempettJISC opened this issue Jul 28, 2017 · 1 comment
Assignees
@andiempettJISC
Labels
docs enhancement

Comments

@andiempettJISC
Copy link
Collaborator

The documentation for peakaboo needs a little work. could cause confusion on how to get started and set up for a new user
Readme.md at the root of the project:
an introduction to the project
how to run in dev
settings.json
how to run in docker for production
@andiempettJISC andiempettJISC self-assigned this Jul 28, 2017
@andiempettJISC andiempettJISC mentioned this issue Jul 28, 2017
Merged
andiempettJISC added a commit that referenced this issue Jul 28, 2017
@andiempettJISC
Merge pull request #42 from SussexLearningSystems/39_update_docs
9aa8174 
#39 update docs
@andiempettJISC
Copy link
Collaborator Author

@pmgration @ppettit ive added some docs in the form of an updated readme. it should make it easier for people to get started with the app. please have a check over and if you're OK with it i'll get it in master
thanks

@andiempettJISC andiempettJISC mentioned this issue Jul 31, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andiempettJISC andiempettJISC

Labels
docs enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@andiempettJISC