Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme.md Update #274

Closed
wants to merge 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Bug Report Form (Beta)
description: File a bug report.
title: "[Bug] "
labels: ["bug", "unconfirmed"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened? What are the steps to reproduce the issue?
description: Describe the bug and include the steps to replicate the issue. Issues with images or videos will be resolved faster.
placeholder: Clearly explain the issue. Please limit each post to one issue.
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: What did you expect to happen?
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: dropdown
id: version
attributes:
label: BoringNotch Version
description: What version of our software are you running?
options:
- 2.3
- 2.2
- 2.1
- 2.0
- 1.8
validations:
required: true
- type: input
id: operating-system
attributes:
label: MacOS Version
description: Go to  > About This Mac
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: checks
attributes:
label: Checks
description:
options:
- label: I haven't found any duplicates with my issue.
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: ''
labels: 'bug,unconfirmed'
assignees: ''

---
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,27 @@
<a href="https://github.com/TheBoredTeam/boring.notch/releases/download/glowing-panda/GlowingPanda.dmg" target="_self"><img width="200" src="https://www.adviksoft.com/blog/wp-content/uploads/2023/09/editor_download_mac.png" /></a>

> [!WARNING]
> We don't have Apple Developer account yet. The applications will show a popup on first start. Click **Okay**, then go to **Settings / Privacy & Security** and scroll down until you see a button **Open anyway**. You'll have to do this once.
> We don't have an Apple Developer account yet. The application will show a popup on first start. Click **Okay**, then, go to **Settings / Privacy & Security** and scroll down until you see a button called **Open anyway**. You'll only have to do this once.
## Website
> [!NOTE]
> Hey There 👋 We have a new website at https://theboring.name! Go check it out for stuff like:
> - All current bugs
> - People's opinions about Boring.Notch
> - All current features
> - Q&A answers
## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline)](https://star-history.com/#TheBoredTeam/boring.notch&Timeline)

## Buy us coffee
## Buy us a coffee!

<a href="https://www.buymeacoffee.com/jfxh67wvfxq" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>

## Join our Community on Discord
## Join our Discord Server (new)

<a href="https://discord.gg/GvYcYpAKTu" target="_blank">
<img src="https://www.kindpng.com/picc/m/221-2215393_discord-human-action-hd-png-download.png" width="200" alt="Discord - Human Action, HD Png Download@kindpng.com" />
</a>
<a href="https://discord.gg/GvYcYpAKTu" target="_blank"><img src="https://iili.io/28m3GHv.png" alt="Join The Boring Server!" style="height: 60px !important;width: 217px !important;" ></a>

## Preview

Expand All @@ -37,7 +43,7 @@ Welcome to **Boring.Notch**, the coolest way to make your MacBook's notch the st

### Prerequisites

- **A MacBook**: With a boring notch.
- **A MacBook**: With a boring notch (Not Needed).
- **macOS 14.2 or later**: If you’re not on the latest macOS, we might need to send a search party.
- **Xcode 15.0 or later**: This is where the magic happens, so make sure it’s up-to-date.

Expand Down Expand Up @@ -125,4 +131,4 @@ This work is licensed under the Creative Commons Attribution-NonCommercial-NoDer
We would like to express our appreciation to the developers of [NotchDrop](https://github.com/Lakr233/NotchDrop), an open-source project that has been instrumental in developing the "Shelf" feature in Boring.notch. Special thanks to Lakr233 for their contributions to NotchDrop and to [Hugo Persson](https://github.com/Hugo-Persson) for integrating it into our project.

- **SwiftUI**: For making us look like coding wizards.
- **You**: For being awesome and checking out **boring.notch**!
- **You**: For being awesome and checking out **boring.notch**!

This file was deleted.