-
-
Notifications
You must be signed in to change notification settings - Fork 196
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
Showing
1 changed file
with
12 additions
and
7 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,14 +1,19 @@ | ||
# RedditOS | ||
A SwiftUI Reddit client for macOS | ||
|
||
You'll need Xcode 12 and macOS Big Sur 12 to build & run the app. | ||
This is quite bleeding edge, the performances are not quite there yet as SwiftUI higher order components on macOS (like `List` and `NavigationView`) are not really very smooth yet. I hope it'll improve during Big Sur update cycle and I exept a big boost with SwiftUI 3 next summer. (One can hope) | ||
## About | ||
|
||
But I'll continue to work on this application, add features, optimize it and eventually release it on the Mac App Store. | ||
![Image](Images/image1.png?) | ||
This project is about two things: | ||
1. Building a good Reddit client. | ||
2. Building a good macOS application using mostly SwiftUI. | ||
|
||
If you want to login with your Reddit account building the project from the source you'll need to create a file `secrets.plist` in `Packages/Backend/Sources/Backend/Resources` with your Reddit app id as `client_id` key/value. Create an reddit app [here](https://www.reddit.com/prefs/apps) and use `redditos:https://auth` as redirect url. | ||
You'll need the latest version of Xcode 12 and macOS Big Sur to build it and enjoyt it. | ||
You can also download a pre built version in the release section if you don't want to build it youself. | ||
|
||
I'm planning to drop Big Sur in the near future to focus execlusively on SwiftUI 3 + macOS Monterey. | ||
SwiftUI 3 add a ton of features, polish and performance improvements that this application can't live without. | ||
|
||
I'll periodically release pre built version of the app in the repository. | ||
## Dev environement | ||
|
||
If you want to login with your Reddit account building the project from the source you'll need to create a file `secrets.plist` in `Packages/Backend/Sources/Backend/Resources` with your Reddit app id as `client_id` key/value. Create an reddit app [here](https://www.reddit.com/prefs/apps) and use `redditos:https://auth` as redirect url. | ||
|
||
The app is still early and SwiftUI on macOS is not that fast (yet) but I'm planning to release it on the Mac App Store with the release of Big Sur. |