diff --git a/README b/README deleted file mode 100644 index e7c87048b..000000000 --- a/README +++ /dev/null @@ -1,16 +0,0 @@ -criu -==== - -An utility to checkpoint/restore tasks. Using this tool, you can -freeze a running application (or part of it) and checkpoint it to -a hard drive as a collection of files. You can then use the files -to restore and run the application from the point it was frozen -at. The distinctive feature of the CRIU project is that it is -mainly implemented in user space. - -The project home is at http://criu.org - -Pages worth starting with are -* Kernel configuration, compilation, etc: http://criu.org/Installation -* A simple example of usage: http://criu.org/Simple_loop -* More sophisticated example with graphical app: http://criu.org/VNC diff --git a/README.md b/README.md new file mode 100644 index 000000000..a301e00c2 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +## CRIU (Checkpoint and Restore in Userspace) + +An utility to checkpoint/restore tasks. Using this tool, you can freeze a +running application (or part of it) and checkpoint it to a hard drive as a +collection of files. You can then use the files to restore and run the +application from the point it was frozen at. The distinctive feature of the CRIU +project is that it is mainly implemented in user space. + +The project home is at http://criu.org. + +Pages worth starting with are: +- [Kernel configuration, compilation, etc](http://criu.org/Installation) +- [A simple example of usage](http://criu.org/Simple_loop) +- [More sophisticated example with graphical app](http://criu.org/VNC) + +### How to contribute + +* [How to submit patches](http://criu.org/How_to_submit_patches); +* Send all bug reports to [mailing +list](https://lists.openvz.org/mailman/listinfo/criu); +* Spread the word about CRIU in [social networks](http://criu.org/Contacts);