aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrendan Forster <github@brendanforster.com>2018-10-27 10:41:57 -0300
committerBrendan Forster <github@brendanforster.com>2018-10-28 18:17:26 -0300
commit37ec8ba529097314ea1707b36317c6f71fc98dea (patch)
tree56eeb9d24e19a808da544f51ed746ac30baf5ce4
parent663ff83ba7ad73d631bcca79918a8491398db165 (diff)
downloadgitignore-37ec8ba529097314ea1707b36317c6f71fc98dea.tar.gz
gitignore-37ec8ba529097314ea1707b36317c6f71fc98dea.zip
add section about updated folder structure
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index adb59664..77018198 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,17 @@ the following resources are a great place to start:
## Folder structure
-The files in the root directory are for `.gitignore` templates that are
-project-specific, such as language or framework specific templates.
-Global (operating system or editor specific) templates should go into the
-[`Global/`](./Global) directory.
+We support a collection of templates, organized in this way:
+
+- [`Global`](./Global) contains templates for various editors, tools and
+ operating systems that can be used in different situations. It is recommended
+ that you either [add these to your global template](https://help.github.com/articles/ignoring-files/#create-a-global-gitignore)
+ or merge these rules into your project-specific templates if you want to use
+ them permanently.
+- [`ecosystem`](./ecosystem) contains specialized templates coalescing around
+ popular programming languages, but don't make sense to live in the mainstream
+ templates. These should be added to your project-specific templates when you
+ decide to adopt the framework or tool.
## Contributing guidelines