https://github.com/cmdln/flashbake

Scripts to gather information for including in version history comments and to make using source control a bit simpler for non-technical projects.
https://github.com/cmdln/flashbake

Last synced: about 1 month ago
JSON representation

Scripts to gather information for including in version history comments and to make using source control a bit simpler for non-technical projects.

• Host: GitHub
• URL: https://github.com/cmdln/flashbake
• Owner: cmdln
• License: gpl-3.0
• Created: 2009-02-18T22:01:27.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2022-05-29T17:45:14.000Z (over 2 years ago)
• Last Synced: 2024-10-01T06:27:20.778Z (2 months ago)
• Language: Python
• Homepage:
• Size: 437 KB
• Stars: 456
• Watchers: 21
• Forks: 39
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: COPYING.txt

Awesome Lists containing this project

• my-awesome-github-stars - cmdln/flashbake - Scripts to gather information for including in version history comments and to make using source control a bit simpler for non-technical projects. (Python)

README

        
# Welcome to Flashbake

Flashbake is about helping writers use Git version control to archive the evolution of their work. 

This can include the initial creation of the work, edits to the work, as well as metadata surrounding the writing process. 

The metadata is configurable and pulls in information from the user's lifelog such as recent social media posts, blog posts, music listening, current weather, location, and more.

It then commits that metadata and textual changes to an archive at set intervals.

As [Cory Doctorow describes it](https://craphound.com/news/2009/02/13/flashbake-free-version-control-for-writers-using-git/) Flashbake is about recording, "Where am I, what’s it like there, and what am I thinking about?”

## How Flashbake was born

Flashbake first rolled out in 2009 as a result of discussions between Cory Doctorow and Thomas Gideon. Cory was looking for a way to reintroduce the trail of edits, 

notes, annotations, and so on that grow out of writing by hand or typewriter; this collection of material automatically records how a piece of writing develops and can be a boon to historians, archivists, as well as the writers themselves. 

With computers that natural archive disappears since writers are often using a single file or set of files that are constantly being edited. Version histories built into most text editing programs 

aren't up to solving this problem, nor are automated backup services. 

Source control, however, is an excellent tool for archiving incremental changes, but most tools expect the author to 

manually commit their changes along the way.  Flashbake takes these two notions and combines the convenience of automated backup with the power of source version control. 

## How to use Flashbake

If you'd like to install Flashbake and use it for your projects check out the [wiki](https://github.com/cmdln/flashbake/wiki) for instructions on how to [install](https://github.com/cmdln/flashbake/wiki/Installation), [configure](https://github.com/cmdln/flashbake/wiki/Configuration), and [run](https://github.com/cmdln/flashbake/wiki/Running) Flashbake.

## Joining the Flashbake community

If you'd like to contribute to Flashbake by helping with code or documentation, [check out our contributor's guide](https://github.com/cmdln/flashbake/wiki/Contributor's-Guide). 

## Further reading

Cory Doctorow's [initial blog post about the inspiration for Flashbake](https://craphound.com/news/2009/02/13/flashbake-free-version-control-for-writers-using-git/).

Thomas Gideon's [initial blog post about developing Flashbake](https://web.archive.org/web/20120202215523/http://bitbucketlabs.net/flashbake).