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

Configure README #1

Merged
merged 1 commit into from
Jul 23, 2024
Merged
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
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# Revolt iOS
<div align="center">
<h1>
Revolt iOS

[![Stars](https://img.shields.io/github/stars/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/stargazers)
[![Forks](https://img.shields.io/github/forks/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/network/members)
[![Pull Requests](https://img.shields.io/github/issues-pr/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/pulls)
[![Issues](https://img.shields.io/github/issues/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/issues)
[![Contributors](https://img.shields.io/github/contributors/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/graphs/contributors)
[![License](https://img.shields.io/github/license/revoltchat/ios?style=flat-square&logoColor=white)](https://github.com/revoltchat/ios/blob/main/LICENSE)
</h1>
Native iOS app for Revolt
</div>
<br/>

iOS app
This repository contains the source code for the native iOS application.

> [!IMPORTANT]
> This app is still in early stages, and not yet ready for production.

## Development

### Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

#### Prerequisites

- macOS with Xcode installed.

#### Installation

1. **Clone the repository:** \
`git clone https://github.com/revoltchat/ios.git`

2. **Open the project in Xcode:** \
Open `Revolt.xcworkspace` in Xcode.

3. **Build and run the app:** \
Select your target device or simulator and hit the run button.

## License

All content contained within this repository is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/ios/blob/main/LICENSE). Dependencies may be licensed differently._