구희연

Add README.md template

Showing 1 changed file with 253 additions and 0 deletions
1 +<div id="top"></div>
2 +<!--
3 +*** Thanks for checking out the Best-README-Template. If you have a suggestion
4 +*** that would make this better, please fork the repo and create a pull request
5 +*** or simply open an issue with the tag "enhancement".
6 +*** Don't forget to give the project a star!
7 +*** Thanks again! Now go create something AMAZING! :D
8 +-->
9 +
10 +
11 +
12 +<!-- PROJECT SHIELDS -->
13 +<!--
14 +*** I'm using markdown "reference style" links for readability.
15 +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
16 +*** See the bottom of this document for the declaration of the reference variables
17 +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
18 +*** https://www.markdownguide.org/basic-syntax/#reference-style-links
19 +-->
20 +[![Contributors][contributors-shield]][contributors-url]
21 +[![Forks][forks-shield]][forks-url]
22 +[![Stargazers][stars-shield]][stars-url]
23 +[![Issues][issues-shield]][issues-url]
24 +[![MIT License][license-shield]][license-url]
25 +[![LinkedIn][linkedin-shield]][linkedin-url]
26 +
27 +
28 +
29 +<!-- PROJECT LOGO -->
30 +<br />
31 +<div align="center">
32 + <a href="https://github.com/othneildrew/Best-README-Template">
33 + <img src="images/logo.png" alt="Logo" width="80" height="80">
34 + </a>
35 +
36 + <h3 align="center">Best-README-Template</h3>
37 +
38 + <p align="center">
39 + An awesome README template to jumpstart your projects!
40 + <br />
41 + <a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
42 + <br />
43 + <br />
44 + <a href="https://github.com/othneildrew/Best-README-Template">View Demo</a>
45 + ·
46 + <a href="https://github.com/othneildrew/Best-README-Template/issues">Report Bug</a>
47 + ·
48 + <a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a>
49 + </p>
50 +</div>
51 +
52 +
53 +
54 +<!-- TABLE OF CONTENTS -->
55 +<details>
56 + <summary>Table of Contents</summary>
57 + <ol>
58 + <li>
59 + <a href="#about-the-project">About The Project</a>
60 + <ul>
61 + <li><a href="#built-with">Built With</a></li>
62 + </ul>
63 + </li>
64 + <li>
65 + <a href="#getting-started">Getting Started</a>
66 + <ul>
67 + <li><a href="#prerequisites">Prerequisites</a></li>
68 + <li><a href="#installation">Installation</a></li>
69 + </ul>
70 + </li>
71 + <li><a href="#usage">Usage</a></li>
72 + <li><a href="#roadmap">Roadmap</a></li>
73 + <li><a href="#contributing">Contributing</a></li>
74 + <li><a href="#license">License</a></li>
75 + <li><a href="#contact">Contact</a></li>
76 + <li><a href="#acknowledgments">Acknowledgments</a></li>
77 + </ol>
78 +</details>
79 +
80 +
81 +
82 +<!-- ABOUT THE PROJECT -->
83 +## About The Project
84 +
85 +[![Product Name Screen Shot][product-screenshot]](https://example.com)
86 +
87 +There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
88 +
89 +Here's why:
90 +* Your time should be focused on creating something amazing. A project that solves a problem and helps others
91 +* You shouldn't be doing the same tasks over and over like creating a README from scratch
92 +* You should implement DRY principles to the rest of your life :smile:
93 +
94 +Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
95 +
96 +Use the `BLANK_README.md` to get started.
97 +
98 +<p align="right">(<a href="#top">back to top</a>)</p>
99 +
100 +
101 +
102 +### Built With
103 +
104 +This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
105 +
106 +* [Next.js](https://nextjs.org/)
107 +* [React.js](https://reactjs.org/)
108 +* [Vue.js](https://vuejs.org/)
109 +* [Angular](https://angular.io/)
110 +* [Svelte](https://svelte.dev/)
111 +* [Laravel](https://laravel.com)
112 +* [Bootstrap](https://getbootstrap.com)
113 +* [JQuery](https://jquery.com)
114 +
115 +<p align="right">(<a href="#top">back to top</a>)</p>
116 +
117 +
118 +
119 +<!-- GETTING STARTED -->
120 +## Getting Started
121 +
122 +This is an example of how you may give instructions on setting up your project locally.
123 +To get a local copy up and running follow these simple example steps.
124 +
125 +### Prerequisites
126 +
127 +This is an example of how to list things you need to use the software and how to install them.
128 +* npm
129 + ```sh
130 + npm install npm@latest -g
131 + ```
132 +
133 +### Installation
134 +
135 +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
136 +
137 +1. Get a free API Key at [https://example.com](https://example.com)
138 +2. Clone the repo
139 + ```sh
140 + git clone https://github.com/your_username_/Project-Name.git
141 + ```
142 +3. Install NPM packages
143 + ```sh
144 + npm install
145 + ```
146 +4. Enter your API in `config.js`
147 + ```js
148 + const API_KEY = 'ENTER YOUR API';
149 + ```
150 +
151 +<p align="right">(<a href="#top">back to top</a>)</p>
152 +
153 +
154 +
155 +<!-- USAGE EXAMPLES -->
156 +## Usage
157 +
158 +Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
159 +
160 +_For more examples, please refer to the [Documentation](https://example.com)_
161 +
162 +<p align="right">(<a href="#top">back to top</a>)</p>
163 +
164 +
165 +
166 +<!-- ROADMAP -->
167 +## Roadmap
168 +
169 +- [x] Add Changelog
170 +- [x] Add back to top links
171 +- [] Add Additional Templates w/ Examples
172 +- [] Add "components" document to easily copy & paste sections of the readme
173 +- [] Multi-language Support
174 + - [] Chinese
175 + - [] Spanish
176 +
177 +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
178 +
179 +<p align="right">(<a href="#top">back to top</a>)</p>
180 +
181 +
182 +
183 +<!-- CONTRIBUTING -->
184 +## Contributing
185 +
186 +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
187 +
188 +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
189 +Don't forget to give the project a star! Thanks again!
190 +
191 +1. Fork the Project
192 +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
193 +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
194 +4. Push to the Branch (`git push origin feature/AmazingFeature`)
195 +5. Open a Pull Request
196 +
197 +<p align="right">(<a href="#top">back to top</a>)</p>
198 +
199 +
200 +
201 +<!-- LICENSE -->
202 +## License
203 +
204 +Distributed under the MIT License. See `LICENSE.txt` for more information.
205 +
206 +<p align="right">(<a href="#top">back to top</a>)</p>
207 +
208 +
209 +
210 +<!-- CONTACT -->
211 +## Contact
212 +
213 +Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
214 +
215 +Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
216 +
217 +<p align="right">(<a href="#top">back to top</a>)</p>
218 +
219 +
220 +
221 +<!-- ACKNOWLEDGMENTS -->
222 +## Acknowledgments
223 +
224 +Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
225 +
226 +* [Choose an Open Source License](https://choosealicense.com)
227 +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
228 +* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
229 +* [Malven's Grid Cheatsheet](https://grid.malven.co/)
230 +* [Img Shields](https://shields.io)
231 +* [GitHub Pages](https://pages.github.com)
232 +* [Font Awesome](https://fontawesome.com)
233 +* [React Icons](https://react-icons.github.io/react-icons/search)
234 +
235 +<p align="right">(<a href="#top">back to top</a>)</p>
236 +
237 +
238 +
239 +<!-- MARKDOWN LINKS & IMAGES -->
240 +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
241 +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
242 +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
243 +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
244 +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
245 +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
246 +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
247 +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
248 +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
249 +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
250 +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
251 +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
252 +[linkedin-url]: https://linkedin.com/in/othneildrew
253 +[product-screenshot]: images/screenshot.png