Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme for 2.0.0 version #173

Merged
merged 1 commit into from
Oct 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 42 additions & 11 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,11 @@ Probhat, Munir Optima, National (Jatiya) etc.
Most features of https://www.omicronlab.com/avro-keyboard.html[Avro Keyboard] are present in OpenBangla Keyboard.
So Avro Keyboard users will feel right at home in Linux with OpenBangla Keyboard.

OpenBangla Keyboard is the default Bangla writing software for http://www.magpieos.net[MagpieOS], a Bangladeshi Linux distribution.

image:https://github.com/OpenBangla/OpenBangla-Keyboard/workflows/CI/badge.svg[CI, link=https://github.com/OpenBangla/OpenBangla-Keyboard/actions?query=workflow%3ACI+branch%3Amaster] {nbsp}
image:https://img.shields.io/github/downloads/OpenBangla/OpenBangla-Keyboard/total.svg[Downloads, link=https://img.shields.io/github/downloads/OpenBangla/OpenBangla-Keyboard/total.svg] {nbsp}
image:https://img.shields.io/discord/436879388362014740.svg[Discord, link=https://discord.gg/HXK7QnJ]

CAUTION: This project is powered by github 🌟s. Go ahead and *star* it please

https://github.com/OpenBangla/OpenBangla-Keyboard/projects/1[**We're working towards version 2.0 of OpenBangla Keyboard!**]
CAUTION: This project is powered by github 🌟s. Go ahead and *star* it please!


toc::[]
Expand Down Expand Up @@ -71,20 +67,55 @@ toc::[]

== Installation

WARNING: If you had installed OpenBangla Keyboard 1.2.0 or earlier version, please uninstall it first.
IMPORTANT: If you had installed OpenBangla Keyboard 1.2.0 or earlier version, https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Uninstalling-OpenBangla-Keyboard[please uninstall it first.]

First set up our repositories for your distro, then you can install normally with your package manager.

=== Ubuntu & derivatives
Run these commands to set up our repository:
```bash
source /etc/os-release
sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | apt-key add -"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/ubuntu.conf | sed s/@NAME@/$UBUNTU_CODENAME/ > /etc/apt/sources.list.d/openbangla.list"
sudo apt update
sudo apt install openbangla-keyboard
```

Make sure you have a **working internet connection**.
=== Debian & derivatives
Run these commands to set up our repository:
```bash
source /etc/os-release
sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | apt-key add -"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/debian.conf | sed s/@NAME@/$VERSION_CODENAME/ > /etc/apt/sources.list.d/openbangla.list"
sudo apt update
sudo apt install openbangla-keyboard
```

=== Fedora
Run these commands to set up our repository:
```bash
sudp rpm --import https://dl.bintray.com/openbangla/i/pub.key
sudo sh -c "curl https://dl.bintray.com/openbangla/i/fedora.conf > /etc/yum.repos.d/openbangla.repo"
sudo dnf install openbangla-keyboard
```

Open your terminal and run this command on your shell:
=== Archlinux
Run these commands to set up our repository:
```bash
bash -c "$(wget -nv -O- https://git.io/JUGB8)"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | pacman-key -a -"
sudo pacman-key --lsign-key "openbanglateam@gmail.com"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/archlinux.conf >> /etc/pacman.conf"
sudo pacman -Syy
sudo pacman -S openbangla-keyboard
```

Then use iBus UI or run `ibus-setup` to add and activate **OpenBangla Keyboard** as input method.
=== Others
You can also install by downloading necessary packages from our https://github.com/OpenBangla/OpenBangla-Keyboard/releases[Releases] page.

=== Finally
After you have installed OpenBangla Keyboard, you may need to https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Configuring-Environment[configure your desktop environment].

If this does not work out for you, please create an https://github.com/OpenBangla/OpenBangla-Keyboard/issues[Issue]. While we look into the problem, you can check the https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Installing-OpenBangla-Keyboard[Wiki] for distro-specific install instructions.
If this does not work out for you, please create an https://github.com/OpenBangla/OpenBangla-Keyboard/issues[Issue.]

== Community
We are on https://discord.gg/HXK7QnJ[Discord] and https://www.facebook.com/openbanglakeyboard[Facebook].
Expand Down
54 changes: 43 additions & 11 deletions README.bn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,12 @@ endif::[]

https://www.omicronlab.com/avro-keyboard.html[অভ্র কীবোর্ডের] অধিকাংশ ফিচার ওপেনবাংলা কিবোর্ডে রয়েছে, তাই অভ্রর ব্যবহারকারীরা লিনাক্সে এসে এখানে সহজেই স্বাচ্ছন্দ্য বোধ করবেন।

ওপেনবাংলা কিবোর্ড একটি বাংলাদেশি লিনাক্স ডিস্ট্রিবিউশন http://www.magpieos.net[ম্যাগপাইওএস]-এর ডিফল্ট বাংলা ইনপুট পদ্ধতি।

image:https://github.com/OpenBangla/OpenBangla-Keyboard/workflows/CI/badge.svg[CI, link=https://github.com/OpenBangla/OpenBangla-Keyboard/actions?query=workflow%3ACI+branch%3Amaster] {nbsp}
image:https://img.shields.io/github/downloads/OpenBangla/OpenBangla-Keyboard/total.svg[Downloads, link=https://img.shields.io/github/downloads/OpenBangla/OpenBangla-Keyboard/total.svg] {nbsp}
image:https://img.shields.io/discord/436879388362014740.svg[Discord, link=https://discord.gg/HXK7QnJ]

CAUTION: প্রজেক্টটি ভাল লাগলে অনুগ্রহ করে গিটহাব 🌟 দিয়ে উৎসাহিত করুন!

https://github.com/OpenBangla/OpenBangla-Keyboard/projects/1[**আমরা ওপেনবাংলা কিবোর্ড ২.০ সংস্করণ প্রকাশের জন্য কাজ করছি!**]

toc::[]

Expand All @@ -67,30 +64,65 @@ toc::[]
** চন্দ্রবিন্দুর অবস্থান সংশোধন।


== ইনস্টল
== ইনস্টল পদ্ধতি

IMPORTANT: ওপেনবাংলা কিবোর্ড ১.৫.১ অথবা পূর্ববর্তী সংস্করণ ইনস্টল করা থাকলে https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Uninstalling-OpenBangla-Keyboard[সেটি প্রথমে আনইনস্টল করে নিন।]

প্রথমে আপনার ডিস্ট্রোর জন্য আমাদের রিপজিটরি যোগ করুন, তারপর আপনার প্যাকেজ ম্যানেজার দিয়ে স্বাভাবিকভাবে ইনস্টল করতে পারবেন।

=== উবুন্টু এবং উবুন্টু-ভিত্তিক ডিস্ট্রো
নিচের কমান্ডগুলো দিয়ে আমাদের রিপজিটরি যোগ করে নিন:
```bash
source /etc/os-release
sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | apt-key add -"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/ubuntu.conf | sed s/@NAME@/$UBUNTU_CODENAME/ > /etc/apt/sources.list.d/openbangla.list"
sudo apt update
sudo apt install openbangla-keyboard
```

WARNING: ওপেনবাংলা কিবোর্ড ১.২.০ অথবা পূর্ববর্তী সংস্করণ ইনস্টল করা থাকলে সেটি প্রথমে আনইনস্টল করে নিন।
=== ডেবিয়ান এবং উবুন্টু-ভিত্তিক ডিস্ট্রো
নিচের কমান্ডগুলো দিয়ে আমাদের রিপজিটরি যোগ করে নিন:
```bash
source /etc/os-release
sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | apt-key add -"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/debian.conf | sed s/@NAME@/$VERSION_CODENAME/ > /etc/apt/sources.list.d/openbangla.list"
sudo apt update
sudo apt install openbangla-keyboard
```

ইনস্টলের সময় **কার্যকর ইন্টারনেট সংযোগ** প্রয়োজন।
=== ফেদোরা
নিচের কমান্ডগুলো দিয়ে আমাদের রিপজিটরি যোগ করে নিন:
```bash
sudp rpm --import https://dl.bintray.com/openbangla/i/pub.key
sudo sh -c "curl https://dl.bintray.com/openbangla/i/fedora.conf > /etc/yum.repos.d/openbangla.repo"
sudo dnf install openbangla-keyboard
```

ওপেনবাংলা কিবোর্ড ইন্সটল করার জন্য টার্মিনাল উইন্ডো খুলে এই কমান্ডটি রান করুন:
=== আর্চলিনাক্স
নিচের কমান্ডগুলো দিয়ে আমাদের রিপজিটরি যোগ করে নিন:
```bash
bash -c "$(wget -nv -O- https://git.io/JUGB8)"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | pacman-key -a -"
sudo pacman-key --lsign-key "openbanglateam@gmail.com"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/archlinux.conf >> /etc/pacman.conf"
sudo pacman -Syy
sudo pacman -S openbangla-keyboard
```

এরপর আইবাসের উইন্ডো থেকে অথবা `ibus-setup` কমান্ডের মাধ্যমে **OpenBangla Keyboard** ইনপুট পদ্ধতি হিসেবে যোগ করে নিন।
=== অন্যান্য
এছাড়া আমাদের https://github.com/OpenBangla/OpenBangla-Keyboard/releases[রিলিজ] পাতা থেকে উপযুক্ত প্যাকেজ ডাউনলোড করেও ইনস্টল করতে পারেন।

=== শেষ ধাপ
ওপেনবাংলা কিবোর্ড ইনস্টলের পর আপনার https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Configuring-Environment[ডেস্কটপ এনভায়রনমেন্ট কনফিগার] করার প্রয়োজন হতে পারে।

এই প্রক্রিয়া কাজ না করলে দয়া করে একটি https://github.com/OpenBangla/OpenBangla-Keyboard/issues[গিটহাব ইস্যু] তৈরি করুন। আমরা সমস্যাটি সমাধানের চেষ্টা করবো, তাছাড়া আমাদের https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Installing-OpenBangla-Keyboard[উইকিতে] ডিস্টিবিউশন-ভিত্তিক বিস্তারিত ইনস্টল পদ্ধতি দেখতে পারেন।
এই প্রক্রিয়া কাজ না করলে দয়া করে একটি https://github.com/OpenBangla/OpenBangla-Keyboard/issues[গিটহাব ইস্যু] তৈরি করুন।


== কমিউনিটি
https://discord.gg/HXK7QnJ[ডিসকর্ড] এবং https://www.facebook.com/openbanglakeyboard[ফেসবুকে] আমাদের সাথে আলাপ করতে পারেন।

== কম্পাইল

ওপেনবাংলা কিবোর্ড কম্পাইলের তথা সোর্সকোড থেকে বিল্ড করার জন্য বর্তমানে নিম্নোলিখিত ডিপেন্ডেসিগুলো প্রয়োজন:
ওপেনবাংলা কিবোর্ড কম্পাইল তথা সোর্সকোড থেকে বিল্ড করার জন্য বর্তমানে নিম্নোলিখিত ডিপেন্ডেসিগুলো প্রয়োজন:

* GNU GCC, G++ compiler or Clang
* Rust 1.34.0 or later
Expand Down