mirror of
https://github.com/anyproto/anytype-kotlin.git
synced 2025-06-08 05:47:05 +09:00
OPEN-14 App | License | Add License + small instruction updates (#145)
This commit is contained in:
Sergey Fuksman
parent
293cd2a43b
commit
c9882c083f
GPG key ID:
4AEE18F83AFDEB23
2 changed files with 89 additions and 39 deletions
54
LICENSE.md
Normal file
54
LICENSE.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
Any Source Available License 1.0
|
||||
|
||||
This license contains the terms and conditions under which Any Association
|
||||
makes available its Software. Your use of the Software is subject to these
|
||||
terms and conditions.
|
||||
|
||||
Any Association grants you (“Licensee”) a license to use, modify, and
|
||||
redistribute the Software, but only
|
||||
(a) for Non-Commercial Use, or (b) for Commercial Use in Allowed Networks.
|
||||
|
||||
If Licensee makes available a copy of the Software to any third party,
|
||||
the Software must be subject to the terms of this license only, and Licensee
|
||||
must provide a copy of this license to that third party.
|
||||
If Licensee makes changes or additions to the Software, Licensee may license
|
||||
those changes or additions under terms of your choice, but Licensee cannot
|
||||
change the license for the Software.
|
||||
|
||||
These terms do not allow Licensee to sublicense or transfer any of Licensee’s
|
||||
rights to anyone else. These terms do not imply any other licenses not
|
||||
expressly granted in this license.
|
||||
|
||||
If Licensee violates any of these terms, or uses the Software in a way not
|
||||
uthorized under this license, the license granted to Licensee ends
|
||||
immediately.
|
||||
If Licensee makes, or authorizes any other person to make, any written claim
|
||||
that the Software, or any other Any Association Product, infringes or
|
||||
contributes to infringement of any patent, all rights granted to Licensee
|
||||
under this license end immediately.
|
||||
|
||||
As far as the law allows, the Software is provided AS IS,
|
||||
without any warranty or condition, and Any Association will not be liable
|
||||
to Licensee for any damages arising out of these terms or the use or nature
|
||||
of the Software, under any kind of legal claim.
|
||||
|
||||
Terms in this license are used as follows:
|
||||
|
||||
A “Any Association Product” is any product or service offered by
|
||||
Any Association or its affiliates.
|
||||
|
||||
“Non-Commercial Use” means personal, academic, scientific, or research and
|
||||
development use, or evaluating the Software, but does not include uses where
|
||||
the Software facilitates any transaction of economic value other than on
|
||||
Allowed Networks.
|
||||
|
||||
Any use that is not a Non-Commercial Use is a “Commercial Use.”
|
||||
|
||||
“Allowed Networks” (https://networks.any.coop) are the networks,
|
||||
identified by their unique ids, names, or list of nodes, that are expressly
|
||||
authorized by Any Association, to which the Software may send requests.
|
||||
Any Association may add networks to this list, and, upon reasonable notice,
|
||||
remove networks from it.
|
||||
|
||||
To “use” means any use, modification, distribution or other exploitation of
|
||||
the Software or any part of it.
|
||||
74
README.md
74
README.md
|
|
@ -1,27 +1,29 @@
|
|||
# Anytype.io - Mobile
|
||||
# Anytype
|
||||
|
||||
### Build project
|
||||
Official Anytype client for Android.
|
||||
|
||||
##### Prerequisites
|
||||
## Build project
|
||||
|
||||
- Download `anytype/anytype-android` (private) repository from Github
|
||||
### Prerequisites
|
||||
|
||||
- Clone this repository
|
||||
|
||||
- Create `github.properties` file in root project folder:
|
||||
|
||||
```
|
||||
gpr.usr=GITHUB_USER_ID
|
||||
gpr.key=GITHUB_PERSONAL_ACCESS_TOKEN
|
||||
```
|
||||
```
|
||||
gpr.usr=GITHUB_USER_ID
|
||||
gpr.key=GITHUB_PERSONAL_ACCESS_TOKEN
|
||||
```
|
||||
|
||||
Your Github ID (starting with '#' character) can be found [here](https://caius.github.io/github_id/). As to your personal Github access token, you can generate it in `Developer settings` in your profile settings on Github.
|
||||
|
||||
- Create `apikeys.properties` file in root project folder:
|
||||
|
||||
```
|
||||
amplitude.debug="AMPLITUDE_DEBUG_KEY"
|
||||
amplitude.release="AMPLITUDE_RELEASE_KEY"
|
||||
sentry_dsn="SENTRY_DSN_KEY"
|
||||
```
|
||||
```
|
||||
amplitude.debug="AMPLITUDE_DEBUG_KEY"
|
||||
amplitude.release="AMPLITUDE_RELEASE_KEY"
|
||||
sentry_dsn="SENTRY_DSN_KEY"
|
||||
```
|
||||
|
||||
Then build project.
|
||||
|
||||
|
|
@ -33,33 +35,15 @@ Based on your IDE setup, you might experience problems while accessing/importing
|
|||
idea.max.intellisense.filesize=3500
|
||||
```
|
||||
|
||||
### Setup your Firebase account for Anytype
|
||||
## Useful links
|
||||
|
||||
We're using *Firebase App Distribution* + *Firebase Crashlytics*. We have two separate projects: one for `debug` builds (which we distribute mostly for our Q&A team), another one for `release` builds.
|
||||
[Our tech change log](https://github.com/anyproto/anytype-kotlin/blob/main/CHANGELOG.md)
|
||||
|
||||
### Install the latest Anytype Android release:
|
||||
[Anytype Android app dependencies](https://github.com/anyproto/anytype-kotlin/blob/main/gradle/libs.versions.toml)
|
||||
|
||||
From [Google Play](https://play.google.com/store/apps/details?id=com.anytypeio.anytype).
|
||||
## Conventions
|
||||
|
||||
Or [download](https://download.anytype.io/) an apk for your device architecture from our website.
|
||||
|
||||
### Join our community & telegram channels
|
||||
|
||||
[Official Anytype community](https://community.anytype.io/).
|
||||
|
||||
[Follow what community writes about our Android client](https://community.anytype.io/tag/Android).
|
||||
|
||||
[Join our Android Testers telegram channel](https://t.me/+vEb8COFY7rY5Mzli).
|
||||
|
||||
### Useful links
|
||||
|
||||
[Our tech change log](https://github.com/anytypeio/android-anytype/blob/develop/CHANGELOG.md).
|
||||
|
||||
[Anytype Android app dependencies](https://github.com/anytypeio/android-anytype/blob/develop/gradle/libs.versions.toml).
|
||||
|
||||
### Conventions
|
||||
|
||||
##### PR naming:
|
||||
### PR naming
|
||||
```
|
||||
{TASK-ID} {APP AREA} | {NATURE OF CHANGE: Fix, Enhancement, Feature, Design, Documentation} | {CONCISE DESCRIPTION OF WHAT HAS BEEN DONE}
|
||||
```
|
||||
|
|
@ -70,19 +54,19 @@ DI, scripting, etc.), etc.
|
|||
Example: *Editor | Fix | Show meaningful message when failed to open file by an existing
|
||||
application*
|
||||
|
||||
##### Git branch naming
|
||||
### Git branch naming
|
||||
|
||||
```
|
||||
{TASK_ID or TASK_NUMBER}-ConciseDescription
|
||||
```
|
||||
|
||||
##### Flags
|
||||
### Flags
|
||||
|
||||
```
|
||||
com.anytype.ci=true - for CI/CD pipeline
|
||||
```
|
||||
|
||||
### Updating MW (basics)
|
||||
## Updating anytype-heart (basics)
|
||||
|
||||
Prerequisite: `brew install jq`
|
||||
|
||||
|
|
@ -94,3 +78,15 @@ Prerequisite: `brew install jq`
|
|||
|
||||
2. Make sure your proto files located in `protocol/main/proto/` compile.
|
||||
3. Make sure to update `middlewareVersion` version in `libs.versions.toml`.
|
||||
|
||||
## Contribution
|
||||
Thank you for your desire to develop Anytype together.
|
||||
|
||||
Currently, we're not ready to accept PRs, but we will in the nearest future.
|
||||
|
||||
Follow us on [Github](https://github.com/anyproto) and join the [Contributors Community](https://github.com/orgs/anyproto/discussions).
|
||||
|
||||
---
|
||||
Made by Any — a Swiss association 🇨🇭
|
||||
|
||||
Licensed under [Any Source Available License 1.0](./LICENSE.md).
|
||||
Loading…
Add table
Add a link
Reference in a new issue