Skip to content

Commit 842ac63

Browse files
committed
Merge pull request google#105 from erictleung/add-license-logo-and-format-readme
Reflow README to 80 characters & add license logo
2 parents 2a576b1 + 5ec31fe commit 842ac63

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
Google Style Guides
22
===================
33

4-
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.
4+
Every major open-source project has its own style guide: a set of conventions
5+
(sometimes arbitrary) about how to write code for that project. It is much
6+
easier to understand a large codebase when all the code in it is in a
7+
consistent style.
58

6-
“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.
9+
“Style” covers a lot of ground, from “use camelCase for variable names” to
10+
“never use global variables” to “never use exceptions.” This project holds the
11+
style guidelines we use for Google code. If you are modifying a project that
12+
originated at Google, you may be pointed to this page to see the style guides
13+
that apply to that project.
714

8-
Our [C++ Style Guide][cpp], [Objective-C Style Guide][objc], [Java Style Guide][java], [Python Style Guide][py], [R Style Guide][r], [Shell Style Guide][sh], [HTML/CSS Style Guide][htmlcss], [JavaScript Style Guide][js], [AngularJS Style Guide][angular], [Common Lisp Style Guide][cl], and [Vimscript Style Guide][vim] are now available. We have also released [cpplint][cpplint], a tool to assist with style guide compliance, and [google-c-style.el][emacs], an Emacs settings file for Google style.
15+
Our [C++ Style Guide][cpp], [Objective-C Style Guide][objc], [Java Style
16+
Guide][java], [Python Style Guide][py], [R Style Guide][r], [Shell Style
17+
Guide][sh], [HTML/CSS Style Guide][htmlcss], [JavaScript Style Guide][js],
18+
[AngularJS Style Guide][angular], [Common Lisp Style Guide][cl], and [Vimscript
19+
Style Guide][vim] are now available. We have also released [cpplint][cpplint],
20+
a tool to assist with style guide compliance, and [google-c-style.el][emacs],
21+
an Emacs settings file for Google style.
922

10-
If your project requires that you create a new XML document format, our [XML Document Format Style Guide][xml] 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.
23+
If your project requires that you create a new XML document format, our [XML
24+
Document Format Style Guide][xml] may be helpful. In addition to actual style
25+
rules, it also contains advice on designing your own vs. adapting an existing
26+
format, on XML instance document formatting, and on elements vs. attributes.
1127

12-
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.
28+
These style guides are licensed under the CC-By 3.0 License, which encourages
29+
you to share these documents. See http://creativecommons.org/licenses/by/3.0/
30+
for more details.
31+
32+
<a rel="license" href="http://creativecommons.org/licenses/by/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a>
1333

1434
[cpp]: http://google.github.io/styleguide/cppguide.html
1535
[objc]: http://google.github.io/styleguide/objcguide.xml

0 commit comments

Comments
 (0)