Skip to content

Commit

Permalink
Merge pull request #1 from cgarciaromaguera/cgarciaromaguera-document…
Browse files Browse the repository at this point in the history
…ation

Update README.md
  • Loading branch information
cgarciaromaguera committed Feb 12, 2023
2 parents f924e89 + f06f2a2 commit 9481092
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Google Style Guides
# Ad logo if applicable
// if headers are added, recommend using a table of contents

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
Expand All @@ -12,6 +14,11 @@ 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.

# How to use the Project
//include how to change Google originated projects to intended style guide
// how to change style guides on Google

# Style Guides

* [AngularJS Style Guide][angular]
* [Common Lisp Style Guide][cl]
Expand All @@ -33,12 +40,21 @@ This project also contains [cpplint][cpplint], a tool to assist with style guide
compliance, and [google-c-style.el][emacs], an Emacs settings file for Google
style.

# Installation/Run Process

// Add installation process
// Recommend description of installation process for different devices

# Additional Formats

If your project requires that you create a new XML document format, the
[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.

# License

The style guides in this project are licensed under the CC-By 3.0 License, which
encourages you to share these documents. See
[https://creativecommons.org/licenses/by/3.0/][ccl] for more details.
Expand Down Expand Up @@ -79,3 +95,10 @@ changes, but we are primarily optimizing for Google's internal needs.
[xml]: https://google.github.io/styleguide/xmlstyle.html
[dart]: https://www.dartlang.org/guides/language/effective-dart
[ccl]: https://creativecommons.org/licenses/by/3.0/

# Badges
//include project badges
//inform developers on what they are doing

# Test
//include tests to see how style guides are implemented

0 comments on commit 9481092

Please sign in to comment.