Skip to content

Commit 7fe6d1f

Browse files
committed
Ignoring any subfolder of user/themes/ and user/plugins/
Added instructions on how to pull the required theme and plugins
1 parent 8f0a9bc commit 7fe6d1f

File tree

5 files changed

+60
-0
lines changed

5 files changed

+60
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Thumbs.db
1717
/images
1818
/user/data/*
1919
!/user/data/index.html
20+
user/plugins/**/
21+
user/themes/**/
2022

2123
# phpstorm
2224
.idea/*

user/plugins/.gitkeep

Whitespace-only changes.

user/plugins/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
About the `themes` and `plugins` folders
2+
========================================
3+
4+
Grav packages come with the default [**antimatter**](antimatter) theme, [**error plugin**](error) and [**problems plugin**](problems).
5+
6+
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.
7+
8+
Dependencies
9+
============
10+
11+
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.
12+
13+
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).
14+
15+
These are what you should do via command line in order to get up and running.
16+
17+
```
18+
git clone http://github.com/getgrav/grav
19+
cd grav/themes
20+
git clone http://github.com/getgrav/grav-theme-antimatter antimatter
21+
cd ../grav/plugins
22+
git clone http://github.com/getgrav/grav-plugin-error error
23+
git clone http://github.com/getgrav/grav-plugin-problems problems
24+
```
25+
26+
27+
[antimatter]: http://github.com/getgrav/grav-theme-antimatter
28+
[error]: http://github.com/getgrav/grav-plugin-error
29+
[problems]: http://github.com/getgrav/grav-plugin-problems

user/themes/.gitkeep

Whitespace-only changes.

user/themes/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
About the `themes` and `plugins` folders
2+
========================================
3+
4+
Grav packages come with the default [**antimatter**](antimatter) theme, [**error plugin**](error) and [**problems plugin**](problems).
5+
6+
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.
7+
8+
Dependencies
9+
============
10+
11+
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.
12+
13+
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).
14+
15+
These are what you should do via command line in order to get up and running.
16+
17+
```
18+
git clone http://github.com/getgrav/grav
19+
cd grav/themes
20+
git clone http://github.com/getgrav/grav-theme-antimatter antimatter
21+
cd ../grav/plugins
22+
git clone http://github.com/getgrav/grav-plugin-error error
23+
git clone http://github.com/getgrav/grav-plugin-problems problems
24+
```
25+
26+
27+
[antimatter]: http://github.com/getgrav/grav-theme-antimatter
28+
[error]: http://github.com/getgrav/grav-plugin-error
29+
[problems]: http://github.com/getgrav/grav-plugin-problems

0 commit comments

Comments
 (0)