Skip to content

Commit 4fc94cf

Browse files
committed
docs: update README.md
1 parent ab0d81f commit 4fc94cf

File tree

3 files changed

+86
-27
lines changed

3 files changed

+86
-27
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A clear and concise description of what you expected to happen.
2323

2424
**System Information:**
2525

26-
- macOS Version: [e.g. 14.5, 15.2]
26+
- macOS Version: [e.g. 14.6, 15.2]
2727
- Blankie Version: [e.g. 1.0.1 (256)]
2828
- Installation Source: [TestFlight Beta / GitHub Release / Mac App Store]
2929

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ When we have a foundation set for translations, we will be looking for contribut
9595
At this time, we're not seeking new sound contributions to Blankie. However, if you have suggestions for sound effects, you are welcomed to post in the [_"What Sounds Would You Add to Blankie?"_ discussion thread](https://github.com/codybrom/blankie/discussions/13).
9696

9797
## Other Contributions
98-
There are undoubtedly other ways to contribute to Blankie that aren't covered above. If you have an idea for a new way to contribute, please open an issue to discuss it!
9998

99+
There are undoubtedly other ways to contribute to Blankie that aren't covered above. If you have an idea for a new way to contribute, please open an issue to discuss it!
100100

101101
## Licensing
102102

README.md

+84-25
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Blankie
44

5-
<small>Ambient sound mixer inspired by <a href="https://github.com/rafaelmardojai/blanket">Blanket</a></small>
5+
<small>Ambient sound mixer for macOS inspired by <a href="https://github.com/rafaelmardojai/blanket">Blanket</a></small>
66

77
[![macOS](https://img.shields.io/badge/14.6+-111111?logo=macOS&logoColor=white&logoSize=auto&logoWidth=25)](https://www.apple.com/macos/)
88
[![Swift](https://img.shields.io/badge/Swift%205-F05138?logo=Swift&logoColor=white)](https://swift.org)
@@ -24,54 +24,113 @@ Blankie makes it easy to mix different ambient sounds into a custom soundscape.
2424
- Individual volume controls for each sound
2525
- Global volume control
2626
- Preset system to save your favorite sound combinations
27-
- Native macOS integration
27+
- Native macOS integration:
2828
- System media controls
2929
- Automatic or customizable light/dark modes
3030
- Automatic or custom accent colors
3131

32-
## Requirements to Run
32+
## Contributing
33+
34+
We welcome contributions from the community! There are many ways to contribute to Blankie:
35+
36+
- **Code**: Help fix bugs, add features, or improve performance
37+
- **Testing**: Try new features and report issues
38+
- **Documentation**: Improve our docs and website
39+
- **Ideas**: Submit feature requests and provide feedback
40+
41+
Before contributing, please review our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
3342

34-
macOS Sonoma 14.6 or later
43+
### Current Priority Areas for Contribution
44+
45+
We're currenly looking for help with:
46+
47+
- [Adding custom sound support](https://github.com/codybrom/blankie/issues/1)
48+
- [Internationalization / Translation](https://github.com/codybrom/blankie/issues/2)
3549

3650
## Development Setup
3751

38-
1. Clone the repository
39-
2. Copy `Configuration.example.xcconfig` to `Configuration.xcconfig`
40-
3. Edit `Configuration.xcconfig` to set your development team and bundle identifier:
52+
1. **Fork the repository and clone it to your local machine.**
53+
54+
2. **Copy `Configuration.example.xcconfig` to `Configuration.xcconfig`.**
55+
- Configuration.xcconfig is ignored by git to keep Bundle IDs and Team IDs private. Do not commit this file publicly to protect your work from impersonation, account misuse, and distribution conflicts.
56+
57+
3. **Add your development team to `Configuration.xcconfig`.**
58+
59+
```plaintext
60+
DEVELOPMENT_TEAM = YOUR_TEAM_ID_HERE
61+
```
62+
63+
- **Apple Developer Program Members:**
64+
- Retrieve your **Team ID**:
65+
1. Open Xcode and go to **Xcode > Preferences > Accounts**.
66+
2. Sign in with your Apple ID if you haven’t already.
67+
3. Select your account, click **Manage Certificates** or **View Details**, and find your **Team ID** under your account name.
68+
- Add your Team ID to `Configuration.xcconfig`:
69+
70+
- **If You Are Not a Member of the Apple Developer Program:**
71+
- You can still test the app on your devices for free by creating an Xcode **Personal Team**. Follow these steps:
72+
1. Open Xcode and go to **Xcode > Preferences > Accounts**.
73+
2. Click the "+" button to add your Apple ID (if not already added).
74+
3. After signing in, Xcode will automatically create a **Personal Team** associated with your Apple ID.
75+
4. Go to **Xcode > Preferences > Accounts**, select your account, and click **View Details**. The Team ID for your Personal Team will be listed.
76+
- Use the Team ID from your Personal Team in `Configuration.xcconfig`:
77+
78+
4. **Set the Bundle Identifier:**
4179
42-
```xcconfig
43-
DEVELOPMENT_TEAM = YOUR_TEAM_ID_HERE
44-
PRODUCT_BUNDLE_IDENTIFIER = com.your.identifier
45-
```
80+
```plaintext
81+
PRODUCT_BUNDLE_IDENTIFIER = com.yournamehere.blankie
82+
```
4683
47-
4. Open `Blankie.xcodeproj` in Xcode
48-
5. Build and run!
84+
- In `Configuration.xcconfig`, set `PRODUCT_BUNDLE_IDENTIFIER` to a unique identifier. You can use any reverse domain name format for the bundle identifier, but it must be unique. You **cannot** use the same bundle identifier as the main Blankie app.
4985
50-
Note: `Configuration.xcconfig` is ignored by git to keep your personal development settings private.
86+
5. **Open `Blankie.xcodeproj` in Xcode**
5187
52-
## Sound Credits
88+
6. **Build and run the project!**
5389
54-
All sounds are used under various open licenses. Full attribution information about sounds licensing available at [Blankie.rest/credits](https://blankie.rest/credits) or on the About screen of the app.
90+
## Documentation
91+
92+
Additional information about Blankie, including an FAQ and more credits, are available on the [Blankie website](https://blankie.rest). The website is created using Astro and hosted on GitHub Pages. The source code is available in the `docs` directory.
93+
94+
Information about the Blankie website's source code can be found in its [README](docs/README.md) file.
5595
5696
## Credits
5797
98+
### Special Thanks
99+
58100
An incredibly special thanks to [Rafael Mardojai CM](https://github.com/rafaelmardojai) and all the contributors to the [Blanket](https://github.com/rafaelmardojai/blanket) project which inspired me to build this app when I couldn't find a free, simple and open-source Mac app like it.
59101
60-
## Contributing
102+
### Sounds
61103
62-
Contributions are welcome! Please feel free to submit a Pull Request. Here are some areas that still need work to bring it to parity with Blanket:
104+
The sounds in Blankie are used under various open licenses. Full attribution information about sounds and licensing is available on the Blankie website at [blankie.rest/credits](https://blankie.rest/credits) or on the About screen of the app.
63105
64-
- [Add custom sound support](https://github.com/codybrom/blankie/issues/1)
65-
- [Internationalization / Translation](https://github.com/codybrom/blankie/issues/2)
106+
### App Logo / Icon
107+
108+
The Blankie logo and app icon were created by [Cody Bromley](https://github.com/codybrom) and are licensed under a <a href="https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer">Creative Commons Attribution 4.0 International license <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""></a>
109+
110+
You may share, copy, and adapt the Blankie logo/icon, but you must give appropriate credit, link to the license, and indicate if changes were made.
111+
112+
Press and media may use the Blankie app icon and logo without modification to reference the Blankie app, provided proper attribution is given.
113+
114+
### Sound Icons
115+
116+
Blankie uses [SF Symbols](https://developer.apple.com/sf-symbols/) for sound icons. SF Symbols are provided by Apple as a system resource, with usage governed by the [Xcode and Apple SDKs Agreement](https://www.apple.com/legal/sla/docs/xcode.pdf). They are not stored in this repository and are not covered by Blankie's license.
117+
118+
## License & Copyright
119+
120+
© 2024 Cody Bromley. All rights reserved.
121+
122+
The Blankie name and trademark rights are reserved. The Blankie logo and app icon are licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
66123
67-
## License
124+
The Blankie source code and website code are copyright Cody Bromley and licensed under the MIT License. Please read Blankie's [LICENSE](LICENSE) for full details. Contributions to Blankie are welcome and will be released under the same license.
68125
69-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
126+
Different components of Blankie (such as sounds, icons, or others) may be covered by different licenses. Full attribution information about sounds and licensing for included items is available on the Blankie website at [blankie.rest/credits](https://blankie.rest/credits) and on the About screen of the app.
70127
71-
## Support
128+
## Support & Community
72129
73-
If you encounter any issues or have feature requests, please file them in the [GitHub Issues](https://github.com/codybrom/blankie/issues) section.
130+
- 🐛 Find a bug? [Open an issue](https://github.com/codybrom/blankie/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=BUG%3A+)
131+
- 💡 Have an idea? [Submit a feature request](https://github.com/codybrom/blankie/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=IDEA%3A+)
132+
- 💬 Join the discussion in our [GitHub Discussions](https://github.com/codybrom/blankie/discussions)
74133
75134
---
76135
77-
Note: Blankie is an independent project built for macOS. Blankie and its developer did not use any of the original code from the Blanket project. Blankie is not affiliated with or endorsed by the Blanket project.
136+
> Blankie is an independent macOS application inspired by Blanket. Blankie was built without re-using any code from the Blanket project, though it does use some of the same openly licensed sound files. Blankie is not affiliated with or endorsed by the Blanket team or any of its contributors.

0 commit comments

Comments
 (0)