|
1 |
| -<!-- Logo --> |
2 |
| -<h1 align="center"> |
3 |
| - <img src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/images/logo.png" height="250px" width="300px" alt="Code Style Guide"> |
4 |
| - <br> |
5 |
| - Dog Face Development Co. Code Style Guide |
6 |
| -</h1> |
7 |
| - |
8 |
| -<!-- Copy --> |
9 |
| -<h4 align="center">The Dog Face Development Co. Code Style Guide, published as Markdown files and as a web page.</h4> |
10 |
| - |
11 |
| -<!-- Badges --> |
12 |
| -<div align="center"> |
13 |
| - <!-- Stability --> |
14 |
| - <img alt="Docker State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/docker-publish.yml/badge.svg"> |
15 |
| - <!-- Stability --> |
16 |
| - <img alt="GitHub Pages State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/pages-build-deployment.yml/badge.svg"> |
17 |
| - <!-- CodeQL --> |
18 |
| - <img alt="CodeQL State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/codeql-analysis.yml/badge.svg"> |
19 |
| - <!-- Version --> |
20 |
| - <img alt="GitHub Version" src="https://img.shields.io/github/v/release/Dog-Face-Development/DFD-Code-Style-Guide?include_prereleases"> |
21 |
| - <!-- Issues --> |
22 |
| - <img alt="GitHub Issues" src="https://img.shields.io/github/issues/Dog-Face-Development/DFD-Code-Style-Guide"> |
23 |
| - <!-- Pull Requests --> |
24 |
| - <img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/Dog-Face-Development/DFD-Code-Style-Guide"> |
25 |
| - <!-- Discord --> |
26 |
| - <img alt="Discord Server ID" src="https://img.shields.io/discord/1016106655450140783"> |
27 |
| - <!-- Language Count --> |
28 |
| - <img alt="GitHub Languages" src="https://img.shields.io/github/languages/count/Dog-Face-Development/DFD-Code-Style-Guide"> |
29 |
| -</div> |
30 |
| - |
31 |
| -<!-- Navigation --> |
32 |
| -<p align="center"> |
33 |
| - <a href="#key-features">Key Features</a> • |
34 |
| - <a href="#how-to-use">How To Use</a> • |
35 |
| - <a href="#contributing">Contributing</a> • |
36 |
| - <a href="#credits">Credits & Contributors</a> |
37 |
| -</p> |
38 |
| - |
39 |
| -## Key Features |
40 |
| - |
41 |
| -* Clear style guide. |
42 |
| -* Available for many programming languages. |
43 |
| -* Available for many programming platforms. |
44 |
| -* Consistency across all projects. |
45 |
| -* Easy to implement. |
46 |
| -* Reusable standards. |
47 |
| -* Available in Markdown and on the web. |
48 |
| -* Cross platform, web browser based. |
49 |
| - |
50 |
| -## How To Use |
51 |
| - |
52 |
| -**To access the latest version of the website visit it at [https://dog-face-development.github.io/DFD-Code-Style-Guide/](https://dog-face-development.github.io/DFD-Code-Style-Guide/).** |
53 |
| - |
54 |
| -**To clone and run your own copy of this website**, you'll need [Git](https://git-scm.com/downloads) installed on your computer. If you would rather not use Git, you can just download the code from GitHub above. From your command line: |
55 |
| - |
56 |
| -```bash |
57 |
| -# Clone this repository |
58 |
| -$ git clone https://github.com/Dog-Face-Development/DFD-Code-Style-Guide.git |
59 |
| - |
60 |
| -# Go into the repository |
61 |
| -$ cd DFD-Code-Style-Guide |
62 |
| - |
63 |
| -# Run the webpage |
64 |
| -$ index.html |
65 |
| -``` |
66 |
| - |
67 |
| -You can also pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line: |
68 |
| - |
69 |
| -```bash |
70 |
| -# Pull image |
71 |
| -$ docker pull docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master |
72 |
| - |
73 |
| -# Run container |
74 |
| -$ docker run -d -p 8000:80 docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master |
75 |
| - |
76 |
| -# Now, navigate to localhost in your browser to see the webpage |
77 |
| -``` |
78 |
| - |
79 |
| -If support is required, please open a **[GitHub Discussion](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/discussions)** or join our **[Discord](https://discord.gg/73azSgcNYt)**. |
80 |
| - |
81 |
| -## Contributing |
82 |
| - |
83 |
| -Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare). |
84 |
| - |
85 |
| -Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us (including how to sign our CLA). |
86 |
| - |
87 |
| -## Credits |
88 |
| - |
89 |
| -This software uses the following open source packages, projects, services or websites: |
90 |
| - |
91 |
| -<!-- Credits Table --> |
92 |
| -<table> |
93 |
| - <tr> |
94 |
| - <th align="center"><img src="https://applets.imgix.net/https%3A%2F%2Fassets.ifttt.com%2Fimages%2Fchannels%2F2107379463%2Ficons%2Fmonochrome_large.png?w=240&h=240&s=8a19bbc158996d098e2fb18310ba7f33" width="150" height="150" alt="GitHub"/></th> |
95 |
| - <th align="center"><img src="https://pbs.twimg.com/profile_images/1069553420854591489/stZUQMcC_400x400.jpg" width="150" height="150" alt="W3C"/></th> |
96 |
| - <th align="center"><img src="https://videos.w3schools.com/files/images/w3schools_logo_500_04AA6D.png" width="150" height="150" alt="W3Schools"/></th> |
97 |
| - <th align="center"><img src="https://assets.simpleanalytics.com/press/logo-ratio-1-1/square.svg" width="150" height="150" alt="Simple Analytics"/></th> |
98 |
| - </tr> |
99 |
| - <tr> |
100 |
| - <td align="center">GitHub</td> |
101 |
| - <td align="center">W3C</td> |
102 |
| - <td align="center">W3Schools</td> |
103 |
| - <td align="center">Simple Analytics</td> |
104 |
| - </tr> |
105 |
| - <tr> |
106 |
| - <td align="center"><a href="https://github.com/">Web</a> - <a href="https://github.com/pricing">Plans</a></td> |
107 |
| - <td align="center"><a href="https://www.w3.org">Web</a> - <a href="https://www.w3.org/support/">Donate</a></td> |
108 |
| - <td align="center"><a href="https://www.w3schools.com">Web</a> - <a href="https://www.w3schools.com/pro/index.php">Pro</a></td> |
109 |
| - <td align="center"><a href="https://simpleanalytics.com/?referral=willtheorangeguy">Web</a> - <a href="https://www.simpleanalytics.com/pricing">Plans</a></td> |
110 |
| -</table> |
111 |
| - |
112 |
| -## Contributors |
113 |
| - |
114 |
| -* [@willtheorangeguy](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US) |
115 |
| - |
116 |
| -## You may also like... |
117 |
| - |
118 |
| -* [ProgramVer](https://github.com/Dog-Face-Development/ProgramVer) - An open-source, Python GUI version window to show copyright info and licenses. |
119 |
| -* [PyWorkout](https://github.com/Dog-Face-Development/PyWorkout) - A minimal CLI to keep you inspired during your workout! |
120 |
| -* [PyAvatar](https://github.com/Dog-Face-Development/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites. |
121 |
| - |
122 |
| -## License |
123 |
| - |
124 |
| -This project is licensed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/PRIVACY.md), [Terms and Conditions](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/TERMS.md), and [EULA](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/EULA.md) for legal information. |
| 1 | +<!-- Logo --> |
| 2 | +<h1 align="center"> |
| 3 | + <img src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/images/logo.png" height="250px" width="300px" alt="Code Style Guide"> |
| 4 | + <br> |
| 5 | + Dog Face Development Co. Code Style Guide |
| 6 | +</h1> |
| 7 | + |
| 8 | +<!-- Copy --> |
| 9 | +<h4 align="center">The Dog Face Development Co. Code Style Guide, published as Markdown files and as a web page.</h4> |
| 10 | + |
| 11 | +<!-- Badges --> |
| 12 | +<div align="center"> |
| 13 | + <!-- Stability --> |
| 14 | + <img alt="Docker State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/docker-publish.yml/badge.svg"> |
| 15 | + <!-- Stability --> |
| 16 | + <img alt="GitHub Pages State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/pages-build-deployment.yml/badge.svg"> |
| 17 | + <!-- CodeQL --> |
| 18 | + <img alt="CodeQL State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/codeql-analysis.yml/badge.svg"> |
| 19 | + <!-- Version --> |
| 20 | + <img alt="GitHub Version" src="https://img.shields.io/github/v/release/Dog-Face-Development/DFD-Code-Style-Guide?include_prereleases"> |
| 21 | + <!-- Issues --> |
| 22 | + <img alt="GitHub Issues" src="https://img.shields.io/github/issues/Dog-Face-Development/DFD-Code-Style-Guide"> |
| 23 | + <!-- Pull Requests --> |
| 24 | + <img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/Dog-Face-Development/DFD-Code-Style-Guide"> |
| 25 | + <!-- Discord --> |
| 26 | + <img alt="Discord Server ID" src="https://img.shields.io/discord/1016106655450140783"> |
| 27 | + <!-- Language Count --> |
| 28 | + <img alt="GitHub Languages" src="https://img.shields.io/github/languages/count/Dog-Face-Development/DFD-Code-Style-Guide"> |
| 29 | +</div> |
| 30 | + |
| 31 | +<!-- Navigation --> |
| 32 | +<p align="center"> |
| 33 | + <a href="#key-features">Key Features</a> • |
| 34 | + <a href="#how-to-use">How To Use</a> • |
| 35 | + <a href="#contributing">Contributing</a> • |
| 36 | + <a href="#credits">Credits & Contributors</a> |
| 37 | +</p> |
| 38 | + |
| 39 | +## Key Features |
| 40 | + |
| 41 | +- Clear style guide. |
| 42 | +- Available for many programming languages. |
| 43 | +- Available for many programming platforms. |
| 44 | +- Consistency across all projects. |
| 45 | +- Easy to implement. |
| 46 | +- Reusable standards. |
| 47 | +- Available in Markdown and on the web. |
| 48 | +- Cross platform, web browser based. |
| 49 | + |
| 50 | +## How To Use |
| 51 | + |
| 52 | +**To access the latest version of the website visit it at [https://dog-face-development.github.io/DFD-Code-Style-Guide/](https://dog-face-development.github.io/DFD-Code-Style-Guide/).** |
| 53 | + |
| 54 | +**To clone and run your own copy of this website**, you'll need [Git](https://git-scm.com/downloads) installed on your computer. If you would rather not use Git, you can just download the code from GitHub above. From your command line: |
| 55 | + |
| 56 | +```bash |
| 57 | +# Clone this repository |
| 58 | +$ git clone https://github.com/Dog-Face-Development/DFD-Code-Style-Guide.git |
| 59 | + |
| 60 | +# Go into the repository |
| 61 | +$ cd DFD-Code-Style-Guide |
| 62 | + |
| 63 | +# Run the webpage |
| 64 | +$ index.html |
| 65 | +``` |
| 66 | + |
| 67 | +You can also pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line: |
| 68 | + |
| 69 | +```bash |
| 70 | +# Pull image |
| 71 | +$ docker pull docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master |
| 72 | + |
| 73 | +# Run container |
| 74 | +$ docker run -d -p 8000:80 docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master |
| 75 | + |
| 76 | +# Now, navigate to localhost in your browser to see the webpage |
| 77 | +``` |
| 78 | + |
| 79 | +If support is required, please open a **[GitHub Discussion](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/discussions)** or join our **[Discord](https://discord.gg/73azSgcNYt)**. |
| 80 | + |
| 81 | +## Contributing |
| 82 | + |
| 83 | +Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare). |
| 84 | + |
| 85 | +Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us (including how to sign our CLA). |
| 86 | + |
| 87 | +## Credits |
| 88 | + |
| 89 | +This software uses the following open source packages, projects, services or websites: |
| 90 | + |
| 91 | +<!-- Credits Table --> |
| 92 | +<table> |
| 93 | + <tr> |
| 94 | + <th align="center"><img src="https://applets.imgix.net/https%3A%2F%2Fassets.ifttt.com%2Fimages%2Fchannels%2F2107379463%2Ficons%2Fmonochrome_large.png?w=240&h=240&s=8a19bbc158996d098e2fb18310ba7f33" width="150" height="150" alt="GitHub"/></th> |
| 95 | + <th align="center"><img src="https://pbs.twimg.com/profile_images/1069553420854591489/stZUQMcC_400x400.jpg" width="150" height="150" alt="W3C"/></th> |
| 96 | + <th align="center"><img src="https://videos.w3schools.com/files/images/w3schools_logo_500_04AA6D.png" width="150" height="150" alt="W3Schools"/></th> |
| 97 | + <th align="center"><img src="https://assets.simpleanalytics.com/press/logo-ratio-1-1/square.svg" width="150" height="150" alt="Simple Analytics"/></th> |
| 98 | + </tr> |
| 99 | + <tr> |
| 100 | + <td align="center">GitHub</td> |
| 101 | + <td align="center">W3C</td> |
| 102 | + <td align="center">W3Schools</td> |
| 103 | + <td align="center">Simple Analytics</td> |
| 104 | + </tr> |
| 105 | + <tr> |
| 106 | + <td align="center"><a href="https://github.com/">Web</a> - <a href="https://github.com/pricing">Plans</a></td> |
| 107 | + <td align="center"><a href="https://www.w3.org">Web</a> - <a href="https://www.w3.org/support/">Donate</a></td> |
| 108 | + <td align="center"><a href="https://www.w3schools.com">Web</a> - <a href="https://www.w3schools.com/pro/index.php">Pro</a></td> |
| 109 | + <td align="center"><a href="https://simpleanalytics.com/?referral=willtheorangeguy">Web</a> - <a href="https://www.simpleanalytics.com/pricing">Plans</a></td> |
| 110 | +</table> |
| 111 | + |
| 112 | +## Contributors |
| 113 | + |
| 114 | +- [@willtheorangeguy](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US) |
| 115 | + |
| 116 | +## You may also like... |
| 117 | + |
| 118 | +- [ProgramVer](https://github.com/Dog-Face-Development/ProgramVer) - An open-source, Python GUI version window to show copyright info and licenses. |
| 119 | +- [PyWorkout](https://github.com/Dog-Face-Development/PyWorkout) - A minimal CLI to keep you inspired during your workout! |
| 120 | +- [PyAvatar](https://github.com/Dog-Face-Development/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites. |
| 121 | + |
| 122 | +## License |
| 123 | + |
| 124 | +This project is licensed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/PRIVACY.md), [Terms and Conditions](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/TERMS.md), and [EULA](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/EULA.md) for legal information. |
0 commit comments