Wanchan (Yomitan atšaka)

👋 „Wanchan“ yra „Yomitan“ atšaka (angl. fork), kuri savo ruožtu kilo iš (https://foosoft.net/posts/passing-the-torch-to-yomitan/) projekto „Yomichan“ žr.(migracijos gida). Siekdamas sukurti lietuvišką alternatyvą, atlikau pakeitimus, pritaikiau projektą lietuvių kalbai ir jį modernizavau. Tačiau kartu išlaikiau visą pamatinį funkcionalumą, užtikrinantį, kad projektas veiktų naujausiose naršyklių versijose ir prie jo būtų lengva prisidėti.

📢 Nauji bendraautoriai laukiami!

Kas yra Wanchan (Yomitan)?

„Wanchan“ (Yomitan) paverčia jūsų interneto naršyklę įrankiu, padedančiu ugdyti kalbos raštingumą, leidžiant skaityti tekstus, kuriuos kitaip būtų per sunku įveikti

Šis plėtinys siūlo galingas funkcijas, kurių nerasite kituose naršyklės žodynuose:

• 💬 Interaktyvus iššokantis langas su apibrėžimais paieškos rezultatams rodyti.

• 🔊 Integruotas gimtosios kalbos tarimo garsas su galimybe pridėti savo asmeninius garso šaltinius.

• ✍️ Kanji brūkšnių rašymo eiliškumo diagramos pasiekiamos vienu paspaudimu.

• 📝 Automatinis kortelių kūrimas programai Anki per AnkiConnect įskiepį.

• 🔍 Individualizuotas paieškos puslapis patogiam pasirinktinių paieškos užklausų vykdymui.

• 📖 Kelių žodynų formatų, įskaitant EPWING, palaikymas per Yomitan Import įrankį.

• ✨ Švarus, modernus kodas palengvina kūrėjams prisidėti kuriant naujas funkcijas ir kalbas.

  Pastaba: Kai kurios originalios „Yomitan“ funkcijos buvo supaprastintos ir pritaikytos intuityvesniam naudojimuisi.

Dokumentacija / Kaip naudotis

Kūrėjų dokumentacija

• Anki integracija
  • 🔧 Anki handlebar šablonai
• Pažangios funkcijos
• Problemų sprendimas (Troubleshooting)
  • 🕷️ Žinomos naršyklių klaidos (bugs)

Prisidėjimas (Contributing)

Kadangi tai yra atviro kodo projektas, labai laukiame naujų bendraautorių! Kviečiu naršyti problemų sekimo sistemą (issue tracker) ir perskaityti prisidėjimo gaires.

Būdai, kaip galite padėti:

• Išbandykite dev (kūrėjų) versiją ir praneškite apie klaidas.
• Dokumentuokite UI/UX problemas GitHub Issues platformoje.
• Padėkite atkurti senas klaidas area/bug kategorijoje.

Jei norite rašyti kodą, prieš teikdami „Pull Request“, praneškite, ties kuo planuojate dirbti, sukurdami „GitHub Issue“. Tai leis pateikti grįžtamąjį ryšį iš anksto.

Laukiame:

• Gerai parašytų testų (playwright tests, benchmark tests, unit tests).
• Geresnio tipų (types) padengimo.
• Daugiau ir geresnės dokumentacijos!

Kaip sukompiliuoti (Building) projektą

1. Įdiekite Node.js ir npm.
2. Paleiskite npm ci, kad paruoštumėte aplinką.
3. Paleiskite npm run license-report:html, kad sugeneruotumėte trūkstamą informaciją apie licencijas.
4. Paleiskite npm run build testinei versijai, arba npm run-script build -- --all --version {version} leidimo (release) versijai.
5. Kiekvienos naršyklės kompiliuotus failus rasite builds direktorijoje.

Daugiau informacijos Prisidėjimas (Contributing).

Trečiųjų šalių bibliotekos (Third-Party Libraries)

Projektas naudoja kelias trečiųjų šalių bibliotekas:

Name	License type	Link
@resvg/resvg-wasm	MPL-2.0	git+ssh://git@github.com/yisibl/resvg-js.git
@zip.js/zip.js	BSD-3-Clause	git+https://github.com/gildas-lormeau/zip.js.git
dexie	Apache-2.0	git+https://github.com/dexie/Dexie.js.git
dexie-export-import	Apache-2.0	git+https://github.com/dexie/Dexie.js.git
hangul-js	MIT	git://github.com/e-/Hangul.js.git
kanji-processor	n/a	https://registry.npmjs.org/kanji-processor/-/kanji-processor-1.0.2.tgz
parse5	MIT	git://github.com/inikulin/parse5.git
yomitan-handlebars	MIT	n/a
linkedom	ISC	git+https://github.com/WebReflection/linkedom.git

Padėka / Autorystė (Attribution)

fallback-bloop.mp3 pateikė UNIVERSFIELD ir licencijuota pagal Pixabay Content License.

„Wanchan“ yra „Yomitan“ projekto atšaka (fork). Nuoširdžiai dėkojame originaliems „Yomitan“ ir „Yomichan“ kūrėjams už šį nuostabų atviro kodo įrankį.