Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.88 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.88 KB

Juliet - Julia Interactive Educational Tutor

Windows build: Build status

Unix build: Build Status

Kind-of-dodgy coverage stats: Coverage Status

Juliet is a interactive tutor for Julia that provides a simple yet powerful tutorial framework. It is currently a Google Summer of Code project for the Julia Language.

Though development is at an early stage, please feel free to give feedback or advice. I am unable to test on all systems - if you have a problem, open an issue with your system details and steps to reproduce.

All code is released under the MIT license.

How to use

Juliet is only a framework, and uses separate course packages. An example is provided at BasicSyntaxLesson.

To use, simply import the package:

using BasicSyntaxLesson

and start Juliet:

juliet()

Julia 0.5 Compatibility Issues

Currently not all of Juliet's dependencies work in Julia 0.5. I have reached out to their maintainers, but cannot guarantee speedy updates. Should those dependencies remain incompatible for too long after 0.5's launch, I will endeavour to find or create replacements.

Notes on Tests and Coverage

The Julia 0.5 tests are currently failing due to the issues described above, but the tests pass on 0.4 on Windows, Linux and Mac. Coverage is currently under-reported because the major tests model real-user interaction by running a new process and piping input to it, then observing STDOUT. Unfortunately, Coveralls does not keep track of this.