From c9b9354c6751eae9ea7d6e8910f44d7b31a35719 Mon Sep 17 00:00:00 2001 From: Paul Lindner Date: Fri, 23 Feb 2018 15:19:30 -0800 Subject: [PATCH] Convert README to markdown Change-Id: I6bf7540a5959d00d64f7f2463134f609ca30e4e8 --- BUILDING | 2 +- README | 23 ----------------------- README.md | 19 +++++++++++++++++++ 3 files changed, 20 insertions(+), 24 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/BUILDING b/BUILDING index e1f36d0fe..306c4778c 100644 --- a/BUILDING +++ b/BUILDING @@ -1,6 +1,6 @@ To build Perkeep: -1) Install Go 1.5 or later. +1) Install Go 1.9 or later. 2) cd to the root of the Perkeep source (where this file is) diff --git a/README b/README deleted file mode 100644 index fd1d3beea..000000000 --- a/README +++ /dev/null @@ -1,23 +0,0 @@ -Perkeep is your personal storage system. - -It's a way to store, sync, share, import, model, and back up content. -Keep your stuff for life. - -For more, see: - - https://perkeep.org/ - https://perkeep.org/doc/ - -Other useful files: - - BUILDING how to compile it ("go run make.go") - CONTRIBUTING how to do development and contribute - -Mailing lists: - - http://perkeep.org/lists - -Bugs and contributing: - - https://github.com/perkeep/perkeep/issues - https://perkeep.org/doc/contributing diff --git a/README.md b/README.md new file mode 100644 index 000000000..97bb650a1 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Perkeep is your personal storage system. + +> It's a way to store, sync, share, import, model, and back up content. Keep your stuff for life. + +### For more, see + +- [Perkeep Home](https://perkeep.org/) +- [Perkeep Docs](https://perkeep.org/doc/) + +### Other useful files + +- [BUILDING](BUILDING) - how to compile it ("go run make.go") +- [CONTRIBUTING](CONTRIBUTING.md) - how to do development and contribute + +### Perkeep Resources + +- [Community](http://perkeep.org/community) +- [Bugs and Issues](https://github.com/perkeep/perkeep/issues) +- [Contributing](https://perkeep.org/code#contributing)