Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TeamCCI authored May 9, 2019
1 parent 5c5ec2d commit 5aa49d0
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions pubbly_console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you don't want to buy your own server and install our LAMP CMS yourself, you
* cd /var/www
* sudo rm -r html
* sudo chown ubuntu:ubuntu . -R
* sudo git clone https://github.com/PubblyDevelopment/pubbly_console.git .
* sudo git clone https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_console.git .
* cd /var/www/
* sudo git submodule update --init --recursive
> Pasting in putty or similar HTML shells is done with Control - Shift - Insert.
Expand Down Expand Up @@ -103,21 +103,21 @@ Restart apache 2 to update with all custom settings

Your server is now ready. I strongly advice that you change the root password to something secure, that you disallow the following of system indexes, and other smart software people things.

This is a "from scratch" build of the console, and has no pre-loaded content. To create and upload your own new content, see section "Adding content". You can also create a mirror image of TeamCCI's xprize console. For full instructions, see [Pubbly](https://github.com/PubblyDevelopment/pubbly) section "Submission from existing content". For convenience sake, I have also included a copy of the server specific "Adding content: Preloading Xprize content" steps below.
This is a "from scratch" build of the console, and has no pre-loaded content. To create and upload your own new content, see section "Adding content". You can also create a mirror image of TeamCCI's xprize console. For full instructions, see [Pubbly](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly) section "Submission from existing content". For convenience sake, I have also included a copy of the server specific "Adding content: Preloading Xprize content" steps below.

## Adding content

It is entirely possible to create a brand new program from brand new assets using our tools. This is a large job, and will take artists, content creators, and developers. For a full overview of the process, checkout [Pubbly](https://github.com/PubblyDevelopment/pubbly) section "Submission from scratch".
It is entirely possible to create a brand new program from brand new assets using our tools. This is a large job, and will take artists, content creators, and developers. For a full overview of the process, checkout [Pubbly](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly) section "Submission from scratch".

If you would like to instead start with a mirror image of the console TeamCCI used to create Xprize android applications, checkout [Pubbly](https://github.com/PubblyDevelopment/pubbly) section "Submission from existing: Xprize console duplication"
If you would like to instead start with a mirror image of the console TeamCCI used to create Xprize android applications, checkout [Pubbly](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly) section "Submission from existing: Xprize console duplication"

You can upload new content to either scratch consoles or Xprize dupe console in the same way.

### Adding content: Design Tools Export

To upload content to the pubbly console, first author and export a zip from the design tools. Full instructions can be found at [Pubbly Design Tools](https://github.com/PubblyDevelopment/pubbly_design_tools) section "Authoring books" and "Exports"
To upload content to the pubbly console, first author and export a zip from the design tools. Full instructions can be found at [Pubbly Design Tools](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_design_tools) section "Authoring books" and "Exports"

Once you have a zip, you can upload to two places in the console, Static and Variable exports. A list of all Design Tools exported zips used to create our Xprize Console can be found at [Pubbly Xprize Original Exports](https://github.com/PubblyDevelopment/pubbly_xprize_original_exports)
Once you have a zip, you can upload to two places in the console, Static and Variable exports. A list of all Design Tools exported zips used to create our Xprize Console can be found at [Pubbly Xprize Original Exports](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_xprize_original_exports)

### Adding content: Uploading to Static

Expand All @@ -137,7 +137,7 @@ Static export uploaded. It can be found, viewed, downloaded, reuploaded and rena

A variable export is a book that needs certain assets to be "swapped out". Variable exports are very useful when creating large amounts of content with few developers/authors.

First, create a book in the pubbly design tools with some of the assets set to "variable". Full instructions can be found at [Pubbly Design Tools](https://github.com/PubblyDevelopment/pubbly_design_tools), section "Exports: Variable"
First, create a book in the pubbly design tools with some of the assets set to "variable". Full instructions can be found at [Pubbly Design Tools](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_design_tools), section "Exports: Variable"

Once you have a zip, log into your console

Expand Down Expand Up @@ -350,7 +350,7 @@ The downloaded zip file should contain a file named "MainXML.xml". It may also c

* Attach the pubbly engine

For full instructions on how to attach the pubbly engine to your packet, checkout the [Pubbly Engine](https://github.com/PubblyDevelopment/pubbly_engine) repository readme, section "Attaching"
For full instructions on how to attach the pubbly engine to your packet, checkout the [Pubbly Engine](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_engine) repository readme, section "Attaching"

### Creating packets: Variable Exports

Expand All @@ -360,7 +360,7 @@ We never needed to do specifically this, so the instructions are a little raw, b
* Create a temporary folder on your desktop (~/tmp)
* Navigate to the variable export you want to download (eg /var/www/html/series/{NAME_OF_VARIABLE_EXPORT})
* Download folder "audio", "images", "videos" along with every XML file to your desktop folder ~/tmp
* Clone the [Pubbly Engine](https://github.com/PubblyDevelopment/pubbly_engine) repository to your local
* Clone the [Pubbly Engine](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_engine) repository to your local
> The Pubbly Engine is the required JS and CSS to take the XML and assets of a console based Export, and create an interactive web page (for deployment via Cordova APK wrapper, hosted server, or offline hand-to-hand zips).
* From the Pubbly Engine repository on your local, copy and paste
- pubbly_engine/assets to ~/tmp/pubbly_engine/assets
Expand Down Expand Up @@ -407,10 +407,10 @@ Still possible with SFTP or SSH access to server. Real quick instructions, SFTP

To deploy a packet, first create and download the packet to your local machine. (Steps in section Creating Packets). If you wish to deploy as an offline zip, to be viewed from a desktop browser, email it to whoever you want to have it, tell them to extract and open the index.html file. If you wish to deploy as a hosted webpage, extract to a web accessible folder on your server.

If you wish to distribute as a cordova APK, see [Pubbly SchoolHouse](https://github.com/PubblyDevelopment/pubbly_schoolhouse) section Adding content: Console Map packet
If you wish to distribute as a cordova APK, see [Pubbly SchoolHouse](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_schoolhouse) section Adding content: Console Map packet

### Deploying a Pubbly School house

For our submission in the XPRIZE, Pubbly created a lightweight but messy HTML front end cordova application, and filled it with Stitched and Mapped console packets.

For full instructions on how to take new console packets and distribute in our exact structure, or how to modify the application structure to fit your new idea for a learning program, see [Pubbly SchoolHouse](https://github.com/PubblyDevelopment/pubbly_schoolhouse) section "Adding content" and "Adding content: New program"
For full instructions on how to take new console packets and distribute in our exact structure, or how to modify the application structure to fit your new idea for a learning program, see [Pubbly SchoolHouse](https://github.com/XPRIZE/GLEXP-Team-CCI/tree/master/pubbly_schoolhouse) section "Adding content" and "Adding content: New program"

0 comments on commit 5aa49d0

Please sign in to comment.