https://github.com/ktoso/scalaslide

Awesome landslide & scalatest driven presentation framework, built on sbt
https://github.com/ktoso/scalaslide

Last synced: 21 days ago
JSON representation

Awesome landslide & scalatest driven presentation framework, built on sbt

• Host: GitHub
• URL: https://github.com/ktoso/scalaslide
• Owner: ktoso
• Created: 2012-06-02T01:39:37.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-07-05T16:13:53.000Z (over 12 years ago)
• Last Synced: 2024-12-15T08:52:36.268Z (26 days ago)
• Language: Scala
• Size: 1.74 MB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
ScalaSlide

==========

ScalaSlide - automated slides testing framework

On a side note, the presentation itself is compiled. And not in the sense of "plain markdown to html"!


The presentation is actually an sbt build which extracts all Scala source code from the slides and runs tests with them!

This way I am 100% sure that the presented material both compiles and passes tests :-) Like the idea? Check out the sources on: https://github.com/ktoso/scalaslide.

Here's an example of a run of the sbt build. You just type: `scalaslide:gen [options for landslide]` and here's what you get:



Here's a quick feature list of what scalaslide can do for you:



  


generated test code for each of !scala code blocks in your slides.md file. I'm using ScalaTest, but you can use any framework you want.

  
the tests are then run and the presentation will not be generated until all tests pass. Test Driven Presentation Development!



  
it works with sbt's awesome ~ feature, also known as "watch resources". So it will automatically recompile and run tests (and generate the presentation if they pass) each time the slides.md file changes! This allows to have a great flow while building the presentation on one display, and watching it "generated" on another.

  
it uses google's landslide to generate the presentation, so it's nicely browsable from your browser.

  
landslide can also generate a pdf version of the slides if needed - for handouts for example



Dependencies of ScalaSlide

--------------------------

You will need: 

* [sbt](https://github.com/harrah/xsbt) - scala's simple build tool

* [landslide](https://github.com/adamzap/landslide) - for generating the presentation

The Presentation

----------------

Was prepared and given by me at AGH - University of Science and Technology Kraków in May 2012.

It's under Creative Commons BY, and there's a video online of the talk (although in polish): http://www.blog.project13.pl/index.php/coding/1606/scala-presentation-at-agh-university-of-science-and-technology/

Links

-----

*ScalaSlide* was mentioned in the "Markdown" book published by Tim Steinbach, describing the many many uses of markdown. You can get a copy here if you're into this kind of reads.

License

-------

Just make sure you notice me ([email protected]) or my blog; blog.project13.pl somewhere if you use this ;-)

I'll copy paste a detailed license later...