Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RathanakSreang committed May 22, 2022
1 parent 960cae5 commit 7fbf8a5
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

First off, thanks for considering contributing to Khmerlang Keyboard!

There are several ways to contribute to Khmerlang Keyboard. This document provides some general guidelines for each type of
contribution.

## Giving general feedback

NEW! You can now give [general feedback](http://m.me/khmerlang.official)
to our official Facebook page.

## Adding a new feature or making large changes

If you intend to add a new feature or to make large changes, please discuss this first through a proposal on GitHub.
Discussing your idea enables both you and the dev team that we are on the same page before you start on working on your
change. If you have any questions, feel free to ask for help at any time!

## Adding a new keyboard layout

Adding a layout to Khmerlang Keyboard is very easy. Most of the time is
enough to look at the existing layout files, but the following attempts to help you in creating layouts from scratch.

## Bug reporting

This kind of contribution is the most important, as it tells where Khmerlang Keyboard has flaws and thus should be improved to
maximize stability and user experience.

## Donating

If none of the above options are feasible for you but you still want to show your support, you can also buy me a coffee,
so I can stay up all night and chase away bugs or add new cool stuff :)
Contact to our official [Facebook page](http://m.me/khmerlang.official) for available options!
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<img align="left" width="80" height="80"
src="images/icon.png" alt="App icon">

# Khmerlang Keyboard

<img src="images/phone_8.jpg"
Expand Down Expand Up @@ -41,6 +44,10 @@ Feature it doesn't have and probably will never have:
alt="Get it on Google Play"
height="80">](https://play.google.com/store/apps/details?id=com.rathanak.khmerroman)

## Resources

- [Task management](https://trello.com/b/emfEoZt2)

## Licensed

Licensed under MIT
Expand Down
Binary file added images/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7fbf8a5

Please sign in to comment.