Skip to content

Commit

Permalink
Add written instructions for participants, closes #19
Browse files Browse the repository at this point in the history
  • Loading branch information
esmagoksal committed Oct 10, 2023
1 parent 57ee894 commit 6cd7673
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Welcome to Puzzyx Challenge!

We are very happy to seeing you here!

==**Before starting please make sure filling your details [here](https://forms.gle/6QxSXJ7SWPtWXrP99) to join the shuffle.**==

Puzzyx is a multiplatform application created by lovely Bumble developers using Appyx where we aim to
finish a puzzle with content created by Droidcon attendees! Pick you photo or text content, add it to puzzle and
let it shine on our screen! ✨✨


Here is what you need to do to create your own tile:
- Get Familiar with [Entry](./shared/src/commonMain/kotlin/com/bumble/puzzyx/model/Entry.kt) class and its types
- Pick the Entry type you would like to add
- Shout out to Droidcon what you want to say
- Or get your cool/funny photo and add it to [Resources](./shared/src/commonMain/resources/participant)
- Create your Entry instance inside [Entries.kt](./shared/src/commonMain/kotlin/com/bumble/puzzyx/model/Entries.kt)
- Your tile is good to go! All you need to do is create your PR and ask Bumble team for review!

**Please be mindful about created content, Bumble keeps the right of rejecting a PR.
Any remote images,hate speech, discrimination, explicit content is not allowed.*


## Project page
[https://github.com/bumble-tech/puzzyx](https://github.com/bumble-tech/puzzyx)

## If you want to learn more about Appyx

[https://bumble-tech.github.io/appyx/](hhttps://bumble-tech.github.io/appyx/)

## License

<pre>
Copyright 2023 Bumble.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</pre>

0 comments on commit 6cd7673

Please sign in to comment.