-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
54cecb8
commit c69f21f
Showing
1 changed file
with
16 additions
and
258 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,270 +1,28 @@ | ||
| <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --> | ||
| <a name="readme-top"></a> | ||
| <!-- | ||
| *** Thanks for checking out the Best-README-Template. If you have a suggestion | ||
| *** that would make this better, please fork the repo and create a pull request | ||
| *** or simply open an issue with the tag "enhancement". | ||
| *** Don't forget to give the project a star! | ||
| *** Thanks again! Now go create something AMAZING! :D | ||
| --> | ||
|
|
||
|
|
||
|
|
||
| <!-- PROJECT SHIELDS --> | ||
| <!-- | ||
| *** I'm using markdown "reference style" links for readability. | ||
| *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
| *** See the bottom of this document for the declaration of the reference variables | ||
| *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
| *** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
| --> | ||
| [![Contributors][contributors-shield]][contributors-url] | ||
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![MIT License][license-shield]][license-url] | ||
| [![LinkedIn][linkedin-shield]][linkedin-url] | ||
|
|
||
|
|
||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| ~~~ | ||
| <div align="center"> | ||
| <a href="https://github.com/othneildrew/Best-README-Template"> | ||
| <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Best-README-Template</h3> | ||
|
|
||
| <p align="center"> | ||
| An awesome README template to jumpstart your projects! | ||
| <br /> | ||
| <a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/othneildrew/Best-README-Template">View Demo</a> | ||
| · | ||
| <a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=bug&template=bug-report---.md">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#usage">Usage</a></li> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#contact">Contact</a></li> | ||
| <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| [![Product Name Screen Shot][product-screenshot]](https://example.com) | ||
|
|
||
| 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. | ||
|
|
||
| Here's why: | ||
| * Your time should be focused on creating something amazing. A project that solves a problem and helps others | ||
| * You shouldn't be doing the same tasks over and over like creating a README from scratch | ||
| * You should implement DRY principles to the rest of your life :smile: | ||
|
|
||
| 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! | ||
|
|
||
| Use the `BLANK_README.md` to get started. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| ### Built With | ||
|
|
||
| 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. | ||
|
|
||
| * [![Next][Next.js]][Next-url] | ||
| * [![React][React.js]][React-url] | ||
| * [![Vue][Vue.js]][Vue-url] | ||
| * [![Angular][Angular.io]][Angular-url] | ||
| * [![Svelte][Svelte.dev]][Svelte-url] | ||
| * [![Laravel][Laravel.com]][Laravel-url] | ||
| * [![Bootstrap][Bootstrap.com]][Bootstrap-url] | ||
| * [![JQuery][JQuery.com]][JQuery-url] | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This is an example of how you may give instructions on setting up your project locally. | ||
| To get a local copy up and running follow these simple example steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| This is an example of how to list things you need to use the software and how to install them. | ||
| * npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
|
|
||
| ### Installation | ||
| <a href="https://github.com/technocrat/swingwatch.org.git/"> | ||
| <img src="https://github.com/technocrat/swingwatch.org.git/assets/logo.png" alt="Logo" width="80" height="80"></a> | ||
| ~~~ | ||
| --- | ||
| ## Text, illustrations and underlying code | ||
|
|
||
| _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._ | ||
| [SwingWatch.org](http://swingwatch.org) | ||
|
|
||
| 1. Get a free API Key at [https://example.com](https://example.com) | ||
| 2. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/your_username_/Project-Name.git | ||
| ``` | ||
| 3. Install NPM packages | ||
| ```sh | ||
| npm install | ||
| ``` | ||
| 4. Enter your API in `config.js` | ||
| ```js | ||
| const API_KEY = 'ENTER YOUR API'; | ||
| ``` | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| ## Built with | ||
|
|
||
| *[Julia programming language](julianlang.org) | ||
| *[Franklin.jl site generator](https://franklinjl.org/) | ||
| *[claude.ai assistant](https://claude.ai) | ||
|
|
||
| ## Status | ||
|
|
||
| <!-- USAGE EXAMPLES --> | ||
| ## Usage | ||
| This is the initial commit. The relevant code in the assets/scripts directory is mostly undocumented. | ||
|
|
||
| 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. | ||
| ## Help | ||
|
|
||
| _For more examples, please refer to the [Documentation](https://example.com)_ | ||
| Limited assistance is available through the [issues tab](https://github.com/technocrat/swingwatch.org/issues) for [github users,](github.com) limited to the specifics of the code provided. Pull requests are not being considered at this time. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- ROADMAP --> | ||
| ## Roadmap | ||
|
|
||
| - [x] Add Changelog | ||
| - [x] Add back to top links | ||
| - [ ] Add Additional Templates w/ Examples | ||
| - [ ] Add "components" document to easily copy & paste sections of the readme | ||
| - [ ] Multi-language Support | ||
| - [ ] Chinese | ||
| - [ ] Spanish | ||
|
|
||
| See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues). | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 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". | ||
| Don't forget to give the project a star! Thanks again! | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE.txt` for more information. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Your Name - [@your_twitter](https://twitter.com/your_username) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGMENTS --> | ||
| ## Acknowledgments | ||
|
|
||
| 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! | ||
|
|
||
| * [Choose an Open Source License](https://choosealicense.com) | ||
| * [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| * [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) | ||
| * [Malven's Grid Cheatsheet](https://grid.malven.co/) | ||
| * [Img Shields](https://shields.io) | ||
| * [GitHub Pages](https://pages.github.com) | ||
| * [Font Awesome](https://fontawesome.com) | ||
| * [React Icons](https://react-icons.github.io/react-icons/search) | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [forks-url]: https://github.com/othneildrew/Best-README-Template/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [issues-url]: https://github.com/othneildrew/Best-README-Template/issues | ||
| [license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://linkedin.com/in/othneildrew | ||
| [product-screenshot]: images/screenshot.png | ||
| [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white | ||
| [Next-url]: https://nextjs.org/ | ||
| [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB | ||
| [React-url]: https://reactjs.org/ | ||
| [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D | ||
| [Vue-url]: https://vuejs.org/ | ||
| [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white | ||
| [Angular-url]: https://angular.io/ | ||
| [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 | ||
| [Svelte-url]: https://svelte.dev/ | ||
| [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white | ||
| [Laravel-url]: https://laravel.com | ||
| [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white | ||
| [Bootstrap-url]: https://getbootstrap.com | ||
| [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white | ||
| [JQuery-url]: https://jquery.com | ||
| © 2023, Richard Careaga all rights reserved as to all content of this repository except with respect to the [Julia source code](https://github.com/technocrat/swingwatch.org/tree/main/_assets/script). |