Kurulum dokümanının yazılması

COMU / zemberek-extension

LibreOffice için Türkçe imla denetimi eklentisi.

https://comu.github.io/zemberek-extension

Mozilla Public License 2.0

33 stars 1 forks source link

Kurulum dokümanının yazılması #9

Closed ahmetaa closed 5 years ago

ahmetaa commented 5 years ago

Muhtemelen ilk alfa sürümü öncesi bir kurulum dokümanı yazılması iyi olur. Kökte bulunan README.md içerisine ya da libreoffice-tr-tools dizini içine eklenecek bir README.md içerisine yazabiliriz.

Java kontrolü ve kurulumu
Libre office eklentisinin nereden indirileceği ve nasıl kurulacağı (ekran görüntüleri ile). Ekran görüntülerini de proje içerisinde oluşturacağımız "site" adlı bir dizine ekleyebiliriz.
Uyarılar ve sorumluluk reddi
Olası problemler

Sonradan doküman daha uygun bir yere de aktarılabilir.

ahmetaa commented 5 years ago

Doküman Türkçe olacak. @talhakanyilmaz @okanozdemir biriniz bu konuyu almak ister misiniz?

talhakanyilmaz commented 5 years ago

Bununla ben ilgilenebilirim.

ahmetaa commented 5 years ago

Bu arada indirme bağlantısını şimdilik boş bırakabiliriz. Onun için proje alanında bir release linki veririz herhalde.

talhakanyilmaz commented 5 years ago

Benim 2 sorum var.

Kaynak koddan oxt dosyasını elde etmek için gereken adımları da ekleyelim mi yoksa sadece hazır oxt dosyasının nasıl ekleneceğini açıklamak yeterli mi şimdilik?
Lisans konusunda ne düşünüyoruz? Dokümana lisans ile ilgili de bir not eklense iyi olur sanırım.

ahmetaa commented 5 years ago

Bu kullanıcı dokümanı olduğu için İlk etapta sadece hazır oxt dosyasının indirilmesi olsun
Lisans konusunda ise nihai bir karar vermemiz gerekiyor. Apache2 - zemberek nlp proje lisansı MPL - Libre Office lisansı GPL2 - Popüler FOSS lisansı.

Bana hepsi uyar.

@mdakin @nyucel ne dersiniz? @talhakanyilmaz ve @okanozdemir sizin de görüşleriniz varsa lütfen yazın

ahmetaa commented 5 years ago

Binary için CC türü lisanslar da olabilir tabi.

mdakin commented 5 years ago

Apache2 uygundur bence, lisanslar konusunda cok derin bilgim yok, belki @nyucel daha iyi bir yorum yapabilir.

nyucel commented 5 years ago

LibreOffice projesinin lisanslarına uygun seçersek iyi olur diye düşünüyorum. Onlar MPLv2/LGPLv3+ ikili lisanslamasını kullanıyorlar.

ahmetaa commented 5 years ago

Talha eline sağlık, güzel iş çıkarmışsın. Bir iki düzeltme önereceğim

Başlığı ve eklentinin resmi adını "Zemberek-Extension" yerine "LibreOffice Türkçe Dil Araçları" yapsak daha mı iyi olur diye düşündüm. Bunun nedeni önceden Zemberek isminde bir Libre Office eklentisi vardı, isimlerin karışmasını engelleme adına.
Java kurulumunda openjdk-8-jdk yerine openjdk-8-jre daha iyi olabilir. Bu daha küçük bir kurulum oluyor. Ayrıca "sudo apt-get" Ubuntu'ya özel. Bunu belirtmekte yarar var.
java --version denildiğinde uygun Java kurulu ise ekranda görünecek sonuç yazılabilir.
Olası sorunlar kısmında Bunun erken deneme sürümü olduğunu belirtmekte yarar var. Hataların olabileceği belirtilmeli.

ahmetaa commented 5 years ago

@nyucel Tamam hocam, bence sorun yok, MPLv2 lisansını ekledim.