Add README.md

2021-03-14 13:30:25 -07:00 · 2021-03-14 13:30:25 -07:00 · 52a227e665
parent 3c0d43b3d4
commit 52a227e665
1 changed files with 66 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,66 @@
+# Metatext
+
+A free, open-source iOS Mastodon client.
+
+[Check out the beta on TestFlight](https://testflight.apple.com/join/lW1I3bE0)
+
+## Contributing Bug Reports
+
+GitHub is used for bug tracking. Please search [existing issues](https://github.com/metabolist/metatext/issues) and create a new one if the issue is not yet tracked.
+
+## Contributing Code
+
+See the [architecture section](#Architecture) for an overview of Metatext's code. Make sure you have [SwiftLint](https://github.com/realm/SwiftLint) installed and there are no warnings.
+
+### Sign the Contributor License Agreement (CLA)
+
+In order to publish Metatext's source code under the GNU General Public License and be able to dual-license Metatext to Apple for distribution on the App Store, Metabolist must be the sole copyright holder to Metatext's source code. You will need to [sign Metabolist's CLA](https://metabolist.org/cla/) before your pull request can be merged.
+
+## Building
+
+To build Metatext:
+
+- Clone the repository (`git clone https://github.com/metabolist/metatext.git`)
+- Open `Metatext.xcodeproj` in Xcode
+- Select the top-level "Metatext" item in Xcode and change the team in each target's "Signing & Capabilities" settings to your own
+
+All dependencies are managed using [Swift Package Manager](https://swift.org/package-manager) and will automatically be installed by Xcode.
+
+### Push Notifications
+
+Push notifications will not work in development builds of Metatext unless you host your own instance of [metatext-apns](https://github.com/metabolist/metatext-apns) and change the `pushSubscriptionEndpointURL` constants in [IdentityService.swift](https://github.com/metabolist/metatext/blob/main/ServiceLayer/Sources/ServiceLayer/Services/IdentityService.swift) to its URL.
+
+## Architecture
+
+- Metatext uses the [Model–view–viewmodel (MVVM) architectural pattern](https://en.wikipedia.org/wiki/Model–view–viewmodel).
+- View models are clients of a service layer that abstracts network and local database logic.
+- Different levels of the architecture are in different local Swift Packages. `import DB` and `import MastodonAPI` should generally only be done within the `ServiceLayer` package, and `import ServiceLayer` only within the `ViewModels` package.
+
+## Acknowledgements
+
+Metatext uses the following third-party libraries:
+
+- [BlurHash](https://github.com/woltapp/blurhash)
+- [CombineExpectations](https://github.com/groue/CombineExpectations)
+- [GRDB](https://github.com/groue/GRDB.swift)
+- [SDWebImage](https://github.com/SDWebImage/SDWebImage)
+- [SQLCipher](https://github.com/sqlcipher/sqlcipher)
+
+## Cryptography Notice
+
+This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software.
+BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted.
+See <http://www.wassenaar.org/> for more information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms.
+The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.
+
+## License
+
+Copyright (C) 2021 Metabolist
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program.  If not, see <https://www.gnu.org/licenses/>.