Skip to content

Commit

Permalink
Fix Structure
Browse files Browse the repository at this point in the history
  • Loading branch information
smcnab1 committed Jan 1, 2024
1 parent 0a2ff14 commit 2bfca8c
Show file tree
Hide file tree
Showing 31 changed files with 179 additions and 0 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) YEAR Sam McNab

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
158 changes: 158 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<!-- TOP ROW OF BADGES -->

[![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]
[![Kofi][kofi-badge]][kofi-url]
<a name="readme-top"></a>

<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/smcnab1/project-template-repo">
<img src="images/avatar.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Project Template Repo</h3>

<p align="center">
Jumpstart your development with this versatile template. 🚀📁
<br />
<a href="https://github.com/smcnab1/project-template-repo"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/smcnab1/project-template-repo">View Demo</a>
·
<a href="https://github.com/smcnab1/project-template-repo/issues">Report Bug</a>
·
<a href="https://github.com/smcnab1/project-template-repo/issues">Request Feature</a>
</p>
</div>

<details>
<summary>View Contents</summary>

_Last Updated DATE_
<!-- toc -->

<!-- tocstop -->

</details>

<!-- ABOUT THE PROJECT -->
## About The Project
<div align="center">
<a href="https://github.com/smcnab1/project-template-repo">
<img src="images/screenshot.png" alt="Logo" width="100%" height="auto">
</a>
</div>

This repository is used as a base of laying our all repositories used by [@smcnab1](https://github.com/smcnab1). Containing all key documentation and files required for the basis of a repository.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Features

- ...

### Built with

- Markdown

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Getting started

### Prerequisites

Accessible using browser or GitHub mobile application.

### Install

Click on [this link](https://github.com/new?template_name=project-template-repo&template_owner=smcnab1) to generate new repository from template.

### Usage

Used by anyone to quickly generate repository, following optimal layout.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Back Matter

<!-- ROADMAP -->
### Roadmap

- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
- [ ] Nested Feature

See the [open issues](https://github.com/smcnab1/project-template-repo/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->

<a name="contributing"></a>

### 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" or "feature-request".
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

### License

This project is licensed under the [MIT License](LICENSE.md).

<!-- CONTACT -->

<a name="contact"></a>

### Contact

[![Email][email-badge]][email-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[![GitHub][git-badge]][git-url]
[![Kofi][kofi-badge]][kofi-url]
<br />

<!-- ACKNOWLEDGMENTS -->
### Acknowledgments

* []()
* []()
* []()

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->

[contributors-shield]: https://img.shields.io/github/contributors/smcnab1/project-template-repo.svg?style=for-the-badge
[contributors-url]: https://github.com/smcnab1/project-template-repo/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/smcnab1/project-template-repo.svg?style=for-the-badge
[forks-url]: https://github.com/smcnab1/project-template-repo/network/members
[stars-shield]: https://img.shields.io/github/stars/smcnab1/project-template-repo.svg?style=for-the-badge
[stars-url]: https://github.com/smcnab1/project-template-repo/stargazers
[issues-shield]: https://img.shields.io/github/issues/smcnab1/project-template-repo.svg?style=for-the-badge
[issues-url]: https://github.com/smcnab1/project-template-repo/issues
[license-shield]: https://img.shields.io/github/license/smcnab1/project-template-repo.svg?style=for-the-badge
[license-url]: https://github.com/smcnab1/project-template-repo/blob/master/LICENSE.md
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/sammcnab/
[product-screenshot]: images/screenshot.png
[email-badge]: https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white
[email-url]: mailto:[email protected]
[git-badge]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
[git-url]: https://github.com/smcnab1
[kofi-badge]: https://ko-fi.com/img/githubbutton_sm.svg
[kofi-url]: https://ko-fi.com/sammcnab1
Binary file added images/avatar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2bfca8c

Please sign in to comment.