beginning
This commit is contained in:
parent
8c92b374a9
commit
1142411236
33
README.md
33
README.md
|
|
@ -1,13 +1,15 @@
|
|||
# 
|
||||
|
||||
[](https://GitHub.com/ashutoshgngwr/noice/tags/)
|
||||
[](https://github.com/ashutoshgngwr/noice/blob/master/LICENSE)
|
||||
[](https://hosted.weblate.org/engage/noice/)
|
||||
[](https://opencollective.com/noice)
|
||||
[](https://github.com/ashutoshgngwr/noice/actions?query=workflow%3AAndroid)
|
||||
[](https://github.com/ashutoshgngwr/noice/actions?query=workflow%3A%22Cast+Receiver%22)
|
||||
[](https://codecov.io/gh/ashutoshgngwr/noice)
|
||||
[](https://www.codacy.com/manual/ashutoshgngwr/noice)
|
||||
This *used* to be an open source project, that existed on Github and which published on fdroid ( @fdroidorg@mastodon.social)
|
||||
|
||||
Then they decided to betray their community and start adding DRM type antifeatures. Users started noticing (
|
||||
https://shitposter.club/notice/ABuTRwYjZ3S5HZP7p2 ) ...but this is GPL3 code! So the free software community can step in!
|
||||
|
||||
Let's make this project work again.
|
||||
|
||||
Contribute to this project
|
||||
|
||||
|
||||
|
||||
For a lot of people, a little background noise is helpful to calm down and focus. In some cases, it's also a boost to productivity. Background noise can also help minimize the effects of stress.
|
||||
|
||||
|
|
@ -15,12 +17,11 @@ Noice is an app that allows you to create your own set of background sounds by m
|
|||
|
||||
## Download
|
||||
|
||||
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="100">][f-droid-link]
|
||||
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="100">][google-play-link]
|
||||
We're disabling downloads on fdroid until they switch to our fork.
|
||||
|
||||
## Screenshots
|
||||
|
||||
| | | |
|
||||
| | | |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
|  |  |  |
|
||||
|  |  |  |
|
||||
|
|
@ -28,17 +29,13 @@ Noice is an app that allows you to create your own set of background sounds by m
|
|||
## Documentation
|
||||
|
||||
1. [All notable changes](https://ashutoshgngwr.github.io/noice/CHANGELOG) to the
|
||||
project over time
|
||||
project over time
|
||||
2. The [list of
|
||||
contributors](https://ashutoshgngwr.github.io/noice/contributors)
|
||||
3. [How can you contribute?](https://ashutoshgngwr.github.io/noice/contributing)
|
||||
4. [Code of Conduct](https://ashutoshgngwr.github.io/noice/code-of-conduct)
|
||||
5. [Privacy Policy](https://ashutoshgngwr.github.io/noice/privacy-policy) for
|
||||
application users
|
||||
3. How can you contribute? Send us a Pull Request!
|
||||
5. Privacy Policy : does this even need one?
|
||||
|
||||
## License
|
||||
|
||||
[GNU GPL v3](LICENSE)
|
||||
|
||||
[google-play-link]: https://play.google.com/store/apps/details?id=com.github.ashutoshgngwr.noice&referrer=utm_source%3DGitHub%26utm_campaign%3DREADME
|
||||
[f-droid-link]: https://f-droid.org/app/com.github.ashutoshgngwr.noice
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ bug reports to large features.
|
|||
|
||||
## Workflow
|
||||
|
||||
- We love GitHub issues!
|
||||
- We love Git issues!
|
||||
- For small feature requests, an issue first proposing it for discussion or demo
|
||||
implementation in a PR suffice
|
||||
- For big feature requests, please open an issue to avoid wasting time on a feature
|
||||
|
|
@ -31,16 +31,14 @@ bug reports to large features.
|
|||
|
||||
## Getting started
|
||||
|
||||
1. Ensure that you have the latest Android SDK tools installed on your machine
|
||||
1. Fork the repository to create a copy in your GitHub account. The forked repository
|
||||
should be accessible at `https://github.com/<your-username>/noice`
|
||||
1. Clone the forked repository to your machine
|
||||
1. Open the existing project using Android Studio or any editor of your choice
|
||||
should be accessible at `https://git.nogafam.es/<your-username>/evacuated-noice`
|
||||
2. Clone the forked repository to your machine
|
||||
3. Open the existing project using Android Studio or any editor of your choice
|
||||
|
||||
## Translations
|
||||
# translations
|
||||
|
||||
Please refer to the [Noice project on
|
||||
Weblate](https://hosted.weblate.org/engage/noice/) to contribute translations.
|
||||
work in progress
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -166,17 +164,11 @@ the keys present in `src` array.
|
|||
|
||||
## Guiding Principles
|
||||
|
||||
- We allow anyone to participate in our projects. Tasks can be carried out by anyone
|
||||
that demonstrates the capability to complete them
|
||||
- Always be respectful of one another. Assume the best in others and act with empathy
|
||||
at all times
|
||||
- Collaborate closely with individuals maintaining the project or experienced users.
|
||||
Getting ideas out in the open and seeing a proposal before it's a pull request helps
|
||||
reduce redundancy and ensures we're all connected to the decision-making process
|
||||
- We allow anyone to participate in our projects. Tasks can be carried out by anyone.
|
||||
|
||||
## Releases
|
||||
|
||||
Noice is regularly updated on Google Play Store and F-Droid. A commit with the following
|
||||
The goal is to replace upstream Noice entirely F-Droid. A commit with the following
|
||||
changes is necessary to prepare a new release.
|
||||
|
||||
1. It must bump app version name and code in `app/build.gradle`
|
||||
|
|
@ -187,17 +179,7 @@ changes is necessary to prepare a new release.
|
|||
|
||||
### Play Store
|
||||
|
||||
Noice uses [GitHub actions](https://github.com/ashutoshgngwr/noice/actions) to automatically
|
||||
build and push releases to Google Play store.
|
||||
|
||||
- We have been strictly following [Semantic Versioning](https://semver.org) since 0.4.x
|
||||
- New translations are considered as a feature
|
||||
- All releases tagged in Git repository are pushed to beta track on the Play Store. After ample
|
||||
time, a release is manually promoted to the production track for general availability.
|
||||
- In case a feature is merged into the master branch and a patch release needs to be created for
|
||||
the latest public release, create a temporary branch with pattern `Major.Minor.x` e.g., `1.1.x`.
|
||||
Tag any further patch releases to a commit in this branch. Before the next _non-patch_ release,
|
||||
the temporary branch can be merged into master.
|
||||
Not supported.
|
||||
|
||||
### F-Droid
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
|
||||
_This policy is effective as of 13 July 2021. Last updated on 18 August 2021._
|
||||
|
||||
Noice is open-source software. It is provided at no cost and is intended for use
|
||||
as is.
|
||||
evacuated noice is free software.
|
||||
|
||||
It is provided at no cost and is intended for use as is.
|
||||
|
||||
This page informs users of policies regarding the collection, use and disclosure
|
||||
of information when using Noice. If you choose to use Noice, then you agree to
|
||||
|
|
@ -11,10 +12,9 @@ the data collection and its use as ascribed in this policy.
|
|||
|
||||
## Information collection and use
|
||||
|
||||
Noice collects app usage and behaviour data from users that download it from the
|
||||
Google Play Store. We use the collected data to substantiate design decisions
|
||||
and analyse and diagnose faulty app behaviour. Please note that Noice does not
|
||||
collect data without first obtaining user consent.
|
||||
Please note that evacuated-noice does not collect data without first obtaining user consent.
|
||||
|
||||
In fact we don't wish to even do this, help send us PRs to help reduce data collected.
|
||||
|
||||
### Usage data
|
||||
|
||||
|
|
@ -53,11 +53,10 @@ any other purposes.
|
|||
Store](https://play.google.com/store/apps/details?id=com.github.ashutoshgngwr.noice).
|
||||
See "[Google Play Payments
|
||||
Policy](https://support.google.com/googleplay/android-developer/answer/9858738)"
|
||||
4. **[Open Collective](https://opencollective.com/)**: Noice uses it to accept
|
||||
donations from the users who downloaded Noice using
|
||||
[F-Droid](https://f-droid.org/packages/com.github.ashutoshgngwr.noice/). See
|
||||
"[Open Collective's Privacy
|
||||
Policy](https://opencollective.com/privacypolicy)".
|
||||
4. **[Open Collective](https://opencollective.com/)**: evacuated noice used to use it to accept
|
||||
donations from the users who downloaded Noice using fdroid.
|
||||
|
||||
Don't give upstream money.
|
||||
|
||||
## Security
|
||||
|
||||
|
|
@ -73,4 +72,4 @@ information, we have no way to notify you of changes. Thus you are advised to
|
|||
review this page periodically for changes.
|
||||
|
||||
If you have any questions or concerns regarding this policy, contact me at
|
||||
ashutoshgngwr[at]gmail.com.
|
||||
jeffrey.cliff@gmail.com
|
||||
|
|
|
|||
Loading…
Reference in New Issue