diff --git a/.gitignore b/.gitignore index f3ab92837..480c6e574 100755 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,8 @@ Thumbs.db /images /user/data/* !/user/data/index.html +user/plugins/**/ +user/themes/**/ # phpstorm .idea/* diff --git a/user/plugins/.gitkeep b/user/plugins/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/user/plugins/README.md b/user/plugins/README.md new file mode 100644 index 000000000..c9979956d --- /dev/null +++ b/user/plugins/README.md @@ -0,0 +1,29 @@ +About the `themes` and `plugins` folders +======================================== + +Grav packages come with the default [**antimatter**](antimatter) theme, [**error plugin**](error) and [**problems plugin**](problems). + +Because they are separate projects (and git subtree didn't really work great for us), we are not providing them in the repository. If you plan to clone Grav and use it right away, make sure you grab a copy of the required dependencies. + +Dependencies +============ + +Grav can work perfectly as is but it's not of much use if you don't have at least a theme. It's also a good idea to keep the `error` and `problems` plugins installed. + +So if you decide to use a git copy of Grav, rather than a package, once you cloned it you also want to get a copy of [**antimatter theme**](antimatter), [**error plugin**](error) and [**problems plugin**](problems). + +These are what you should do via command line in order to get up and running. + +``` +git clone http://github.com/getgrav/grav +cd grav/themes +git clone http://github.com/getgrav/grav-theme-antimatter antimatter +cd ../grav/plugins +git clone http://github.com/getgrav/grav-plugin-error error +git clone http://github.com/getgrav/grav-plugin-problems problems +``` + + +[antimatter]: http://github.com/getgrav/grav-theme-antimatter +[error]: http://github.com/getgrav/grav-plugin-error +[problems]: http://github.com/getgrav/grav-plugin-problems diff --git a/user/themes/.gitkeep b/user/themes/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/user/themes/README.md b/user/themes/README.md new file mode 100644 index 000000000..c9979956d --- /dev/null +++ b/user/themes/README.md @@ -0,0 +1,29 @@ +About the `themes` and `plugins` folders +======================================== + +Grav packages come with the default [**antimatter**](antimatter) theme, [**error plugin**](error) and [**problems plugin**](problems). + +Because they are separate projects (and git subtree didn't really work great for us), we are not providing them in the repository. If you plan to clone Grav and use it right away, make sure you grab a copy of the required dependencies. + +Dependencies +============ + +Grav can work perfectly as is but it's not of much use if you don't have at least a theme. It's also a good idea to keep the `error` and `problems` plugins installed. + +So if you decide to use a git copy of Grav, rather than a package, once you cloned it you also want to get a copy of [**antimatter theme**](antimatter), [**error plugin**](error) and [**problems plugin**](problems). + +These are what you should do via command line in order to get up and running. + +``` +git clone http://github.com/getgrav/grav +cd grav/themes +git clone http://github.com/getgrav/grav-theme-antimatter antimatter +cd ../grav/plugins +git clone http://github.com/getgrav/grav-plugin-error error +git clone http://github.com/getgrav/grav-plugin-problems problems +``` + + +[antimatter]: http://github.com/getgrav/grav-theme-antimatter +[error]: http://github.com/getgrav/grav-plugin-error +[problems]: http://github.com/getgrav/grav-plugin-problems