codi.vim icon indicating copy to clipboard operation
codi.vim copied to clipboard

Update screencast

Open metakirby5 opened this issue 8 years ago • 6 comments

The screencast still uses the non-async version of Codi, so it's a bit slow. I plan on updating this at some point, but it's not a priority. Putting this issue up in case someone wants to beat me to it 😝

metakirby5 avatar Aug 15 '16 18:08 metakirby5

is there a specific list of things you need to be in the screencast?

Bretley avatar Aug 22 '16 20:08 Bretley

Hey @bert88sta,

Thanks for asking! My thoughts are that the screencast should be in asciinema format, and have at least the following:

  • Comments to describe what is happening before you do it (in the style of the current screencast)
  • Show variable changes being instantly reflected in relevant expressions
    • e.g. given the following, change 5 to 10 or something:
x = 5
x + 10
  • Show automatic filetype detection when running :Codi
  • Show ability to override filetype using :Codi <filetype>
  • Multiple Codi instances in one tab (do :new and :Codi <filetype> in the resulting split)

There aren't really any strict requirements, besides being reasonably short looking cool 😜 For example, instead of outright showing each individual feature like a checklist, you can do a workflow-style screencast where you're working on a python project and have a split with a Codi target buffer and the associated Codi pane open to try small code snippets. e.g.

+--------------------+
| python project...  |
|                    |
+------------+-------+
| x = 2      |       |
| x * 5      |    10 |
+------------+-------+

If you have any suggestions (different format, additional content in the screencast, etc.), let me know!

metakirby5 avatar Aug 23 '16 01:08 metakirby5

You bring up workflow, I actually think this would be super useful for my exploitation process in pwntools, I've been messing around and it's pretty good so far. As for now, I'll keep in mind what you said and try to work on it, no promises in the immediate as I have a shit ton of simmer homework left for this week

On Aug 22, 2016 9:02 PM, "Ethan Chan" [email protected] wrote:

Hey @bert88sta https://github.com/bert88sta,

Thanks for asking! My thoughts are that the screencast should be in asciinema https://asciinema.org/ format, and have at least the following:

  • Comments to describe what is happening before you do it (in the style of the current screencast https://ptpb.pw/t/%7Ecodi)
  • Show variable changes being instantly reflected in relevant expressions
    • e.g. given the following, change 5 to 10 or something:

x = 5 x + 10

  • Show automatic filetype detection when running :Codi
  • Show ability to override filetype using :Codi
  • Multiple Codi instances in one tab (do :new and :Codi in the resulting split)

There aren't really any strict requirements, besides being reasonably short looking cool 😜 For example, instead of outright showing each individual feature like a checklist, you can do a workflow-style screencast where you're working on a python project and have a split with a Codi target buffer and the associated Codi pane open to try small code snippets. e.g.

+--------------------+ | python project... | | | +------------+-------+ | x = 2 | | | x * 5 | 10 | +--------------------+

If you have any suggestions (different format, additional content in the screencast, etc.), let me know!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/metakirby5/codi.vim/issues/12#issuecomment-241597166, or mute the thread https://github.com/notifications/unsubscribe-auth/AICBCWguLUwXJMTSMyMjW7PnBvUVejtPks5qikaXgaJpZM4JkqBc .

Bretley avatar Aug 23 '16 04:08 Bretley

I think it should be better a gif like here: https://github.com/nteract/hydrogen Because you cannot embed screencast in github README.md, and Codi is easily described in video and hardly in text. So it should be obvious what you get from the first seconds.

slavaGanzin avatar Jul 12 '19 10:07 slavaGanzin

@slavaGanzin As you have probably have already seen, there is a gif in the readme already. The purpose of the screencast was to demonstrate additional features and potential workflows. This takes longer than 15 seconds, which a screencast is better suited for - it can be frustrating to view without playback controls.

metakirby5 avatar Jul 14 '19 03:07 metakirby5

@metakirby5 you're right

slavaGanzin avatar Jul 14 '19 07:07 slavaGanzin