commit c2b8caf2f93c1a854f9c67421ca2bf8e2336565b Author: Google Code Exporter Date: Wed May 20 15:25:10 2015 -0400 Migrating wiki contents from Google Code diff --git a/ProjectHome.md b/ProjectHome.md new file mode 100644 index 0000000..70e093f --- /dev/null +++ b/ProjectHome.md @@ -0,0 +1,9 @@ +Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style. + +“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project holds the style guidelines we use for Google code. If you are modifying a project that originated at Google, you may be pointed to this page to see the style guides that apply to that project. + +Our [C++ Style Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.html), [Objective-C Style Guide](http://google-styleguide.googlecode.com/svn/trunk/objcguide.xml), [Java Style Guide](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html), [Python Style Guide](http://google-styleguide.googlecode.com/svn/trunk/pyguide.html), [Shell Style Guide](http://google-styleguide.googlecode.com/svn/trunk/shell.xml), [HTML/CSS Style Guide](http://google-styleguide.googlecode.com/svn/trunk/htmlcssguide.xml), [JavaScript Style Guide](http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml), [AngularJS Style Guide](https://google-styleguide.googlecode.com/svn/trunk/angularjs-google-style.html), [Common Lisp Style Guide](http://google-styleguide.googlecode.com/svn/trunk/lispguide.xml), and [Vimscript Style Guide](http://google-styleguide.googlecode.com/svn/trunk/vimscriptguide.xml) are now available. We have also released [cpplint](http://google-styleguide.googlecode.com/svn/trunk/cpplint), a tool to assist with style guide compliance, and [google-c-style.el](http://google-styleguide.googlecode.com/svn/trunk/google-c-style.el), an Emacs settings file for Google style. + +If your project requires that you create a new XML document format, our [XML Document Format Style Guide](http://google-styleguide.googlecode.com/svn/trunk/xmlstyle.html) may be helpful. In addition to actual style rules, it also contains advice on designing your own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes. + +These style guides are licensed under the CC-By 3.0 License, which encourages you to share these documents. See http://creativecommons.org/licenses/by/3.0/ for more details. \ No newline at end of file