Ignoring any subfolder of user/themes/ and user/plugins/

Added instructions on how to pull the required theme and plugins
This commit is contained in:
Djamil Legato
2014-08-06 17:01:41 -07:00
parent 8f0a9bc9ff
commit 7fe6d1fcd8
5 changed files with 60 additions and 0 deletions

2
.gitignore vendored
View File

@@ -17,6 +17,8 @@ Thumbs.db
/images
/user/data/*
!/user/data/index.html
user/plugins/**/
user/themes/**/
# phpstorm
.idea/*

0
user/plugins/.gitkeep Normal file
View File

29
user/plugins/README.md Normal file
View File

@@ -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

0
user/themes/.gitkeep Normal file
View File

29
user/themes/README.md Normal file
View File

@@ -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