Skip to content
(very work in progress) parse screenplays with Ruby
Ruby
Branch: edge
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
exe
lib
spec
.codeclimate.yml
.gitignore
.rspec
.rubocop.yml
.todo_lint.yml
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Guardfile
LICENSE.txt
README.md
Rakefile
gems.rb
smashcut.gemspec

README.md

smashcut

Build Status Code Climate Test Coverage Issue Count

This project helps convert Fountain-formatted screenplays to PDF. It's a work in progress. The plan is to release it via RubyGems (and maybe homebrew???) when it's more useful.

smashcut uses parslet to help parse the fountain input and transform it into a rich Screenplay object. That object can be used to produce a PDF (using prawn to produce the PDF). It can also be used to produce a Fountain document, and in theory could be taught to produce other formats like HTML or FDX. I'm not currently interested in implementing those, but can imagine it would be useful.

Installation

Because this is not useful yet I haven't pushed it to the rubygems site. If you'd like to try it, you can follow these steps:

  • git clone git@github.com:maxjacobson/smashcut.git
  • cd smashcut
  • bundle install
  • rake install

At this point, the gem is installed on your system and you can require it from your ruby programs or from within irb.

tests and style

If you'd like to run the tests and linter, just run bundle exec rake. Another option you have is to run bundle exec guard, which will auto-run tests when you edit files.

docs

If you'd like to browse the docs, run bundle exec yard server -r which spins up a server you can visit in your browser at http://localhost:8808. When adding inline documentation (comments above classes, methods, etc) please use the yard syntax.

release process

(Haven't actually done this yet, but) to release a new version of the gem, you will need to:

  • decide what is the new version number
  • edit the version.rb file with a new version number
  • edit the CHANGELOG.md file to describe the new release, and make sure there's an "unreleased" section at the top for future unreleased changes.
  • The commit these changes
  • run bundle exec rake release, which will generate a git tag, push the tag to GitHub, create a new .gem file under the pkg folder, and release that pkg to rubygems.org
  • create a new GitHub release (https://github.com/maxjacobson/smashcut/releases) describing the changes in the new version

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/maxjacobson/smashcut. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

You can’t perform that action at this time.