From d33795e78f192b30577c968ba45670599254a80c Mon Sep 17 00:00:00 2001 From: Riley Labrecque Date: Tue, 5 Jan 2016 04:57:33 -0600 Subject: [PATCH] Move style_guide.md and building.md to docs/ --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- building.md => docs/building.md | 0 style_guide.md => docs/style_guide.md | 0 4 files changed, 4 insertions(+), 4 deletions(-) rename building.md => docs/building.md (100%) rename style_guide.md => docs/style_guide.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44bcd866c..1b2523763 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,9 +26,9 @@ could result in the project being terminated, so just don't do it. ## Style Guide -Please read over [style_guide.md](style_guide.md) before sending pull requests +Please read over [style_guide.md](docs/style_guide.md) before sending pull requests and ensure your code is clean as the buildbot (or I) will make you to fix it :) -[style_guide.md](style_guide.md) has information about using `xb format` and +[style_guide.md](docs/style_guide.md) has information about using `xb format` and various IDE auto formatting tools so that you can avoid having to clean things up later, so be sure to check it out. diff --git a/README.md b/README.md index b9e2b181a..c0052f32c 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,8 @@ run premake for project files/etc. ## Building -See [building.md](building.md) for setup and information about the -`xb` script. When writing code, check the [style guide](style_guide.md) +See [building.md](docs/building.md) for setup and information about the +`xb` script. When writing code, check the [style guide](docs/style_guide.md) and be sure to run clang-format! ## Contributors Wanted! diff --git a/building.md b/docs/building.md similarity index 100% rename from building.md rename to docs/building.md diff --git a/style_guide.md b/docs/style_guide.md similarity index 100% rename from style_guide.md rename to docs/style_guide.md