README.md

Slide

Slide is an open-source, ad-free Reddit browser for iOS. It is based around the Reddift Reddit API wrapper.

Slide is not yet avaliable for download on the App Store, but is currently going through Alpha testing through TestFlight. For more information regarding availability, feel free to join us on the subreddit

Contributing

Getting started

To get started with Slide iOS development, you need to set up Cocoapods integration and open the Coacoapods workspace, not the default xcworkspace. NOTE: To keep dependencies in sync between all contributors, all Pod files have been included in the repository. Please refrain from updating pods unless nececssary.

Below are the steps to getting started if no .xcworkspace file is available:

1. Terminal: sudo gem install cocoapods
2. Safari: Downloaded Slide from GitHub (clone or download -> Download Zip)
3. Terminal: cd Downloads/Slide-iOS-Master/
4. Terminal: pod install
5. Open "Slide for Reddit.xcworkspace" through finder

What needs to be done

Slide is in beta, and there are issues that need to be resolved and some feature additions that need to be integrated before the public version 1 release. Any issues are fair game, but any issue with the "Help Wanted" tag is an issue that I have not started on or that should be straightforward to implement with a single PR! If you have any questions or want to be pointed in the right direction, feel free to send me a PM on Reddit to /u/ccrama, or join us on Discord (top banner)!

Issues

In any project, it's likely that a few bugs will slip through the cracks, so it helps greatly if people document any bugs they find to ensure that they get fixed promptly.

You can view a list of known issues and feature requests using the issue tracker. If you don't see your issue (or you aren't sure) feel free to submit it!

Where appropriate, a screenshot works wonders to help us see exactly what the issue is. You can upload screenshots directly using the GitHub issue tracker or by attaching a link (to Imgur, for example), whichever is easier for you.

Code

If you are a developer and wish to contribute to the app please fork the project and submit a pull request.

If you have any questions, feel free to message me on Discord or drop me a message on Reddit.

Changelog

The file CHANGELOG.md provides an overview of the changes for a release; for a more detailed look at changes to the app, view individual commits.

Licensing

Slide is licensed under the Apache 2 License.

If you find Slide's code useful or you use code from this repository, feel free to let me know!