|
| 1 | +<div id="top"></div> |
| 2 | + |
| 3 | +[![Contributors][contributors-shield]][contributors-url] |
| 4 | +[![Forks][forks-shield]][forks-url] |
| 5 | +[![Stargazers][stars-shield]][stars-url] |
| 6 | +[![Issues][issues-shield]][issues-url] |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +<!-- PROJECT LOGO --> |
| 11 | +<br /> |
| 12 | +<div align="center"> |
| 13 | +<h3 align="center">Smart Contract Examples and Samples</h3> |
| 14 | + |
| 15 | + <p align="center"> |
| 16 | + <a href="https://github.com/smartcontractkit/smart-contract-examples/issues">Report Bug</a> |
| 17 | + · |
| 18 | + <a href="https://github.com/smartcontractkit/smart-contract-examples/issues">Request Feature</a> |
| 19 | + </p> |
| 20 | +</div> |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +<!-- TABLE OF CONTENTS --> |
| 25 | +<details> |
| 26 | + <summary>Table of Contents</summary> |
| 27 | + <ol> |
| 28 | + <li> |
| 29 | + <a href="#about-the-project">About The Project</a> |
| 30 | + </li> |
| 31 | + <li> |
| 32 | + <a href="#getting-started">Getting Started</a> |
| 33 | + </li> |
| 34 | + <li> |
| 35 | + <a href="#downloading-a-single-directory">Downloading A Single Directory</a> |
| 36 | + </li> |
| 37 | + <li> |
| 38 | + <a href="#contributing">Contributing</a> |
| 39 | + </li> |
| 40 | + </ol> |
| 41 | +</details> |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | +<!-- ABOUT THE PROJECT --> |
| 46 | +## About The Project |
| 47 | + |
| 48 | +This repo contains example and sample projects, each in their own directory. |
| 49 | + |
| 50 | +<p align="right">(<a href="#top">back to top</a>)</p> |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +<!-- GETTING STARTED --> |
| 55 | +## Getting Started |
| 56 | + |
| 57 | +Each directory within this repo will have a `README.md` that details everything you need to run the sample. |
| 58 | + |
| 59 | +## Downloading A Single Directory |
| 60 | +```sh |
| 61 | +# Create a directory, and enter it |
| 62 | +mkdir smart-contract-examples && cd smart-contract-examples |
| 63 | + |
| 64 | +# Initialize a Git repository |
| 65 | +git init |
| 66 | + |
| 67 | +# Add this repository as a remote origin |
| 68 | +git remote add -f origin https://github.com/smartcontractkit/smart-contract-examples/ |
| 69 | + |
| 70 | +# Enable the tree check feature |
| 71 | +git config core.sparseCheckout true |
| 72 | + |
| 73 | +# Create the spare-checkout file with the value |
| 74 | +# the directory you wish to download |
| 75 | +# |
| 76 | +# Use the name of the directory as 'REPLACE_ME' |
| 77 | +echo 'REPLACE_ME' >> .git/info/sparse-checkout |
| 78 | + |
| 79 | +## Download with pull |
| 80 | +git pull origin master |
| 81 | +``` |
| 82 | + |
| 83 | +<!-- CONTRIBUTING --> |
| 84 | +## Contributing |
| 85 | + |
| 86 | +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
| 87 | + |
| 88 | +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". |
| 89 | +Don't forget to give the project a star! Thanks again! |
| 90 | + |
| 91 | +1. Fork the Project |
| 92 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 93 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 94 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 95 | +5. Open a Pull Request |
| 96 | + |
| 97 | +<p align="right">(<a href="#top">back to top</a>)</p> |
| 98 | + |
| 99 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 100 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
| 101 | +[contributors-shield]: https://img.shields.io/github/contributors/smartcontractkit/smart-contract-examples.svg?style=for-the-badge |
| 102 | +[contributors-url]: https://github.com/smartcontractkit/smart-contract-examples/graphs/contributors |
| 103 | +[forks-shield]: https://img.shields.io/github/forks/smartcontractkit/smart-contract-examples.svg?style=for-the-badge |
| 104 | +[forks-url]: https://github.com/smartcontractkit/smart-contract-examples/network/members |
| 105 | +[stars-shield]: https://img.shields.io/github/stars/smartcontractkit/smart-contract-examples.svg?style=for-the-badge |
| 106 | +[stars-url]: https://github.com/smartcontractkit/smart-contract-examples/stargazers |
| 107 | +[issues-shield]: https://img.shields.io/github/issues/smartcontractkit/smart-contract-examples.svg?style=for-the-badge |
| 108 | +[issues-url]: https://github.com/smartcontractkit/smart-contract-examples/issues |
0 commit comments