Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 2.07 KB

README.md

File metadata and controls

31 lines (25 loc) · 2.07 KB
Raw

Introduction

This project transforms static code snippets into live, runnable pieces of code.

Installation

NOTE: You need to be serving the given files on a server in order for the web workers to initialize properly

To use this project in your own webpage, do the following:

  1. Clone the repository with git clone https://github.com/cs-education/elc-dev.git
  2. Run cd elc-dev
  3. Run npm run prod to build a production version of the JS files
  • This will optimize for size, so please DO NOT try and open this file at the risk of crashing any reasonable editor
  1. Copy the directory sys from public into public-prod in order to have access to the VM filesystem (the VM will not boot up properly without this)
  2. Add all HTML files to this directory that you wish to add the project to (they must be in the same directory as elc.js, jor1k-worker-min.js, and the sys directory)
  3. Add a <div id="elc"></div> tag to your HTML page
  4. Add a <script type="text/javascript" src="elc.js"></script>
  5. Write any code you wish to be transformed within <pre class="code"></pre> tags
  • You can specify which language you would like to use with either c_cpp or python in the pre tag's class name (e.g. <pre class="code c_cpp"> for C support -- the app will default to C behavior if language not specified)
  1. Start your server and access your HTML pages -- if you followed everything, you should see live code in your browser!

Development and Examples

You can try out the project with our examples to see how it can be used in your own webpage.

  1. Clone the repository with git clone https://github.com/cs-education/elc-dev.git
  2. Run cd elc-dev
  3. Run npm start. This will build the project and start a development server
  4. Go to localhost:8000/public/ and click on any of the HTML files to see different ways to use the project

Other

You can check out my senior thesis under paper.pdf for a more in-depth discussion on the project. In addition, we have live demos and the production version of the files in this repo.