Add a step by step basic usage guide #167
Conversation
Adds a basic usage guide for people not so familiar with front end web development. Includes a follow on guide to adding a loading indicator.
| Now we need to get the zip file from the latest [release](https://github.com/tunapanda/h5p-standalone/releases/latest). | ||
|
|
||
| At the time of writing, this is 3.8.0. We can now unzip the release | ||
| into our new `assets/h5p-standalone` directory: | ||
|
|
||
| ```bash | ||
| unzip ~/Downloads/h5p-standalone-3.8.0.zip -d assets/h5p-standalone | ||
| ``` | ||
|
|
||
| This should create a directory structure something like this: | ||
| ```bash | ||
| find . -type d | ||
|
|
There was a problem hiding this comment.
Shouldn't "basic" users just use the CDN and call it a day?
Something like this https://gist.github.com/0xMurage/50140981a3b540a7ad5c24cc60dbaae3
I think this is a little more hands on.
There was a problem hiding this comment.
Aha, yes, good call! I tend to work with offline devices so it's become my default.
Would you like me to grab parts from your gist and use that as the basis for this doc?
There was a problem hiding this comment.
Please feel free to proceed; it's absolutely fine.
| ## Fancier spinner | ||
|
|
||
| If you'd like a fancier version, you could use some CSS animation | ||
| to spin a spinner while the H5P content loads. |
There was a problem hiding this comment.
I appreciate this, but including this would not only add extra work to maintain it but stray from main objective. Instructions on how to set up a basic spinner is enough for all intents and purposes.
While a fancier spinner would be great to some people, I don't think it’s suited for inclusion in the repo documentation.
We will continue improving the documentation, but for now, it is fine as it is. I have also noted that exported H5P content no longer includes libraries. This is a positive change in some ways, as content can now reuse libraries, reducing storage space. |
Hopefully this should resolve #150
Adds a basic 'direct use' guide for people not so familiar with front end web development.
However, there is a caveat. At the moment examples downloaded from https://h5p.org/content-types-and-applications
don't seem to have the libraries inside the .h5p file!
The H5P docs don't seem to have changed either, so it looks like the libraries should still be there:
https://h5p.org/documentation/developers/h5p-specification
So as it stands, the guide won't work as is with the h5p.org examples. I think we have three options at the moment:
Feel free to edit it. Thank you so much for writing this H5P player!