search

rust-community / rustbridge

[DEPRECATED] Workshop material to teach Rust in the style of Railsbridge
https://github.com/rustbridge/team
Other
166 stars 28 forks source link

Incorporate diffing tool for code example presentations #55

Open broesamle opened 8 years ago

broesamle commented 8 years ago

Instead of using an extra branch* and github as done in the snapshots it would be great if you could just

  1. save a series of example files (Starting from Learners Example version 1, 2...)
  2. Run a diffing tool to visualise the changes from version to version
  3. incorporate the visualisations into your instructions README
  4. If the examples change they need to be rebased, but this should automatically update the links in the README and the visualisations
    • which you would have to rebase whenever something in the base example changes
casey commented 7 years ago

@erickt and I were just talking about doing something like this.

This is done to great effect in this project. It shows how add a bunch of IDEish features to vim. Each commit contains a pointer to the previous and next commit, as well as a comment about what that commit is doing.

https://github.com/jez/vim-as-an-ide/commit/e7b27d1a5161fda92fde586fc0d797c0885469df

loganmzz commented 7 years ago

If modification are handled as successive commit, you can compare files between commit by just using Git / GitHub features. Example: https://github.com/Microsoft/TypeScript/commit/e579d17e7e40a13ea21d26370c3724943088278c#diff-0ce6916552af501746c004823c590d2a