Skip to content

Asciinema recording

Veronika Romashkina edited this page Mar 28, 2020 · 14 revisions

Configuration file to use for demo purposes:

owner      = "demo"
fullName   = "Summoner Demo"
email      = "[email protected]"

test = true
extensions = [ "OverloadedStrings", "TypeApplications" ]
files =
    [ { path = ".stylish-haskell.yaml"
      , url  = "https://raw.githubusercontent.com/kowainik/org/master/.stylish-haskell.yaml"
      }
    , { path = "Extra.md"
      , raw  = "This is an extra file."
      }
    ]

Plan for demo session:

# Make sure you're using the latest version (git hash might be different though)
summon --version
# You can check the list of all available commands with the --help option
summon --help | bat
...
# You can specify some options through TOML configuration
# If you don't have a configuration file, Summoner can help with initializing the default config
summon config --file ~/.summoner-default.toml
bat ~/.summoner-default.toml
# Usually you put your default configs under ~/.summoner.toml, but let's use demo config
bat .summoner-demo.toml
...
summon new demo --file ~/.summoner-demo.toml with --benchmark without --test
... interactive process ...
  Name: demo-project
  Cabal: <Enter>
  Stack: <Enter>
  Description: Demo project
  Category: Testing, Demo
  GitHub actions: yes
  GitHub: yes
  Travis: yes
  AppVeyor: Y
  Lib: yes
  Exe: Y
  Tests: <Enter>
  Bench: y
  Custom prelude: <Enter> (relude, Relude)
  GHC versions: 8.6.5 8.6.6 8.6.7 -- to show error message
  GHC versions: 8.6.5
# Let's examine content of some generated files
cd demo-project
bat CHANGELOG.md
bat README.md
# Cool badges in README!
bat stack.yaml
bat stack-8.6.6.yaml
less demo-project.cabal
bat src/DemoProject.hs
bat benchmark/Main.hs
# Let's build project!
cabal build --enable-tests --enable-benchmarks
cabal bench
# Thanks for watching the full demo!

Commands for recording and uploading demo:

asciinema rec -t "Summoner 2.0 CLI demo" -i 1 demo-summoner-cli.cast  # start recording
asciinema upload demo-summoner-cli.cast # upload demo
Clone this wiki locally