-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/ejbills/DockDoor
- Loading branch information
Showing
3 changed files
with
180 additions
and
0 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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 ejbills | ||
|
|
||
| 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. |
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 |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # DockDoor | ||
|
|
||
| DockDoor is a macOS application developed with Swift and SwiftUI that allows users to manage and interact with application windows on their desktop. It emphasizes ease of use and seamless integration with the macOS environment. This project is open-source, inviting contributions from developers to enhance its functionality and user experience. | ||
|
|
||
| [Download the latest release here](https://github.com/ejbills/DockDoor/releases). | ||
|
|
||
| ## Usage | ||
|
|
||
| - **How do I use the alt-tab functionality?** | ||
| - Ctrl + Tab to open the menu, continue pressing tab to increment forwards, shift + tab to go back. Letting go of control will select the window. | ||
| - **How do I use the dock peeking functionality?** | ||
| - Simply hover over any application with active windows in the dock. | ||
|
|
||
| ## Installation (for contributors) | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - macOS 14.0 or later. | ||
| - Xcode installed on your machine. | ||
|
|
||
| ### Setting Up the Project | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Clone your forked repository to your local machine. | ||
| 3. Open the project in Xcode. | ||
| 4. Build and run the project. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| Contributions to DockDoor are welcome! Here’s how you can get started: | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Basic knowledge of Swift and SwiftUI. | ||
|
|
||
| ### Contribution Guide | ||
|
|
||
| 1. **Branching:** | ||
| - Base all new features off of `main`. | ||
| - Create a new branch for each feature or bug fix: `git checkout -b feature/your-feature-name`. | ||
| 2. **Coding Standards:** | ||
| - Follow Swift coding conventions and style guidelines. | ||
| - Aim for clear, concise, and expressive code. | ||
| 3. **Documentation:** | ||
| - Document your code using comments to explain complex logic or functionality. | ||
| 4. **Testing:** | ||
| - Write unit tests for new features or changes. | ||
| - Ensure existing tests pass before submitting a pull request. |
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 |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
|
|
||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>DockDoor</title> | ||
| <style> | ||
| body { | ||
| font-family: Arial, sans-serif; | ||
| margin: 0; | ||
| padding: 0; | ||
| background-color: #f4f4f4; | ||
| } | ||
|
|
||
| .container { | ||
| max-width: 800px; | ||
| margin: 20px auto; | ||
| padding: 20px; | ||
| background-color: #fff; | ||
| border-radius: 8px; | ||
| box-shadow: 0 0 10px rgba(0, 0, 0, 0.1); | ||
| } | ||
|
|
||
| h1, h2, h3 { | ||
| color: #333; | ||
| } | ||
|
|
||
| a { | ||
| color: #3498db; | ||
| text-decoration: none; | ||
| } | ||
|
|
||
| pre { | ||
| background-color: #f9f9f9; | ||
| padding: 10px; | ||
| border-radius: 5px; | ||
| overflow-x: auto; | ||
| } | ||
|
|
||
| ul { | ||
| padding-left: 20px; | ||
| } | ||
|
|
||
| ul li { | ||
| margin-bottom: 10px; | ||
| } | ||
| </style> | ||
| </head> | ||
|
|
||
| <body> | ||
| <div class="container"> | ||
| <h1>DockDoor</h1> | ||
| <p>DockDoor is a macOS application developed with Swift and SwiftUI that allows users to manage and interact with application windows on their desktop. It emphasizes ease of use and seamless integration with the macOS environment. This project is open-source, inviting contributions from developers to enhance its functionality and user experience.</p> | ||
| <p><a href="https://github.com/ejbills/DockDoor/releases">Download the latest release here</a>.</p> | ||
|
|
||
| <h2>Usage</h2> | ||
| <h3>How do I use the alt-tab functionality?</h3> | ||
| <ul> | ||
| <li>Ctrl + Tab to open the menu, continue pressing tab to increment forwards, shift + tab to go back. Letting go of control will select the window.</li> | ||
| </ul> | ||
| <h3>How do I use the dock peeking functionality?</h3> | ||
| <ul> | ||
| <li>Simply hover over any application with active windows in the dock.</li> | ||
| </ul> | ||
|
|
||
| <h2>Installation (for contributors)</h2> | ||
| <h3>Prerequisites</h3> | ||
| <ul> | ||
| <li>macOS 14.0 or later.</li> | ||
| <li>Xcode installed on your machine.</li> | ||
| </ul> | ||
|
|
||
| <h3>Setting Up the Project</h3> | ||
| <ol> | ||
| <li>Fork the repository.</li> | ||
| <li>Clone your forked repository to your local machine.</li> | ||
| <li>Open the project in Xcode.</li> | ||
| <li>Build and run the project.</li> | ||
| </ol> | ||
|
|
||
| <h2>How to Contribute</h2> | ||
| <h3>Prerequisites</h3> | ||
| <ul> | ||
| <li>Basic knowledge of Swift and SwiftUI.</li> | ||
| </ul> | ||
|
|
||
| <h3>Contribution Guide</h3> | ||
| <h4>Branching:</h4> | ||
| <ul> | ||
| <li>Base all new features off of <code>main</code>.</li> | ||
| <li>Create a new branch for each feature or bug fix: <code>git checkout -b feature/your-feature-name</code>.</li> | ||
| </ul> | ||
| <h4>Coding Standards:</h4> | ||
| <ul> | ||
| <li>Follow Swift coding conventions and style guidelines.</li> | ||
| <li>Aim for clear, concise, and expressive code.</li> | ||
| </ul> | ||
| <h4>Documentation:</h4> | ||
| <ul> | ||
| <li>Document your code using comments to explain complex logic or functionality.</li> | ||
| </ul> | ||
| <h4>Testing:</h4> | ||
| <ul> | ||
| <li>Write unit tests for new features or changes.</li> | ||
| <li>Ensure existing tests pass before submitting a pull request.</li> | ||
| </ul> | ||
| </div> | ||
| </body> | ||
|
|
||
| </html> |