From 26aa126ecb50fd6357bdb0101a8399bcea9cb7dd Mon Sep 17 00:00:00 2001 From: Soitora Date: Fri, 19 Jan 2024 20:33:42 +0100 Subject: [PATCH] Modernize README (#139) * Prepare new Readme * Modernize README * Tweak wording --- .github/assets/logo.png | Bin 0 -> 7639 bytes .github/readme-images/app-icon.png | Bin 736 -> 0 bytes README.md | 151 +++++++++++++++++------------ 3 files changed, 88 insertions(+), 63 deletions(-) create mode 100644 .github/assets/logo.png delete mode 100644 .github/readme-images/app-icon.png diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..529c720df42fbf5ee14919ead560b0995dc33182 GIT binary patch literal 7639 zcma)hWmMD;u=Z~g+@-r&8j%iZSP+ozl0Oa7sUS!$4Hn(CfOIQ}fXI?k!jdA=NQx*W zEamk*@0a`Wo-=3WnKNf*o^LZ}Cdp9$J}H6;0RRB0mZq990D%8NFaU-8GjQ|a;eQ6| zs-mX?0L{tBD+ky=AN1JxzADf#&a(T@5jE5`Ro8X*2Q0Dwcj4D6*0zj^* zH+hdIKgb(YriMO@t{G1Q0G3Z$YAU9|3;TsOUNm25KW%#q#N4)gtE%aqcp<79AAi@W zonj|YW}#nNma#t5I=w--YXWL;?<8uR{d zQID-kC+@wz=spTdoaL)|wDN6OiOT%Ctmf$2mGPSuo3=EX1D zFfuj-N2yrjfcs4SsEeeG~S=dSnp25MUw)*1ZMKfP|0xB0(DNP!|hAm z1$8XjRL*6oGH*S*shz7Wv7*Xr7+MkJcW;g>Dg;jr=tdgfk_Phjk@H z0#h%ia&b0AV0>}LI8yhR2GEP(Wd*jXcm5mY>7>g&5CUoniKT%-pE?p*;Ez-F73%gW z3vS<{)EI>Cf@6I%-9^w9bHSvTie>VDd_Ld#rw6$^gm`!|JI(-ZIjTeuwlVP^4U~~b ztS%)8jg; zc4lfYMp09h%syFx4l79UhSa!^6xAjE9r&11t?O0-0Qo#qcJ227Oz{xZJ_`WCIfzht zclo*OsG7(#_~HD{Rzu-f0JvbQ27>Jb>(1hs0X^+mRRI8p7084I+X+V`JD(oe(rapF zkdFa5dr#wr{M)lIOCIhuQBafmC=gCQTyxzS!@(nEzI?I6U;ZYzJUJc2i_x|`t^1rk z5OnZsM@zD}XAVa<4Cq$JlHz7Q{8as$S~0uDt<-||$zQhstR8%LcVl{gqIIigw%P3o zN4ncB%_bXhAaz7cM}DQzsJ>%irnA0NdD2-x=_31Ub6PnK2^haY%e1*8is^7jQ1TdV zsS9xm+tuF)wA*QS*#Cy1fQJoy^@rs#W_&p_6xlg@0(AwA%bvgUYd;+dZO=A z^JLcHudeSYG%#*8FWi{_wlsh0IQd$RwSk0zziC@QvVSUIf_a1N)P~~6bN8X7N1d2; zzNmZZZCF`JZvOVccT*=ClT;2>j`yy6rkjD951v|SZUVOU|ZbEfu#{14mX z*D=`XP3&)e;tCpR`pDI4&8*W3KVWr$>QfhgtmzdGQsz}M7c10TNcuS(&@b1MI&yZ8 z;%Ty!0lb(~w)__Gy3bjAgL=CxDOQK4IQ`Xw>tQ+6+qYjuX~-oCzlS8?cfJ+CQCFp{ z8LGhYPZ|Mo zB*za$!(l+@e_y`QR)QoEaEzJdp&5}nCi;1XJz!ZP=6ZtwrC8sd2RB79f80YUgMdq) zHYho8H{2m%15i6FsqAw%d9NdMXi)8>qU;3qWDvWtCH}ur| z9~mBK>L8hY0?!+BrVhFo4dQ?MMHa&8mP%DY@=7Peq*(zBeXB=hfCspvUQNymEunM0 zF=eK;;79z!Gpv7K=4%3$suXf9hZE!!=figcqjU(O)WAa};CBsDy|*t39s$Ix1L#{S z`|2EksgW=shcK#3fdQ!RCbYTLp_bD!PvT^4Yys!sWz=02Qe9gJ;1g1Nm2x0alSh3W z8F%Dhx&ACNjpnpNt;%t!`QZ4p_0Yo$DS>SJ75LVp7|?Qkp4HuvrQOEs3O z9G0~_+M1;WoS|3K?FBIVy#?D`$hHk-e zrCIwpMSIYbz3G=~1Rox1zJQ=238>P-I^HY1G@|y^E!t^f4Ps!^)h-B*3E7?o&qWs9 z!N&6q36wSX3oR+6>Jrd(H@VckL6GhVaa!d3U?NQoG?; z0By0R>>NO#{2!Z(Y0TLtrIG}3zoDZI;N#)_NbA*cxslgYdMi+`5$|m^F7}}oAfBA4 zXj3ieO%}mwzXCd29jHWvcas2L4Xj*zE3EZa1C~|*FEUzTcYK%+=&pogcd3#zkk8mW zrQOYpsrOI2Im3)CORAqnEd2$1zKUU1+-``P2I64~st|jSa#JeYix>mK`~FANbe9-z zAD&2&JB0(I=AM5~nduw@7KE75g>1wCeLWM-iisH6q@c(_!GY74v*#e~M>HuYpdQ7; zoM4vwg%-bDK_GiER`d-84KR1%qUEk<2v{nRc56exxOI01&&#Y!Nw3{UVS4r?IIC%U zLr2ux1qtbwFd|H5me{Es2yDM5sjDpjf#Q1I8LrT!-!B1V_Qq=yBpGlgdn4*A%!MrG z?L)99u6ZiJBgks@)aDtuLk0Ev+bSj4HI;#(i8h4? z_v==VZ}j;9^$|6(B?$u$R;{lMIr0*=tMiQMqm5w$yC|`rmM_Wzqh&wN^U)b=^WXHf zH{|X9HQyt4E>iG-0>{(~Gjw=ic~((IFlqVU2QSdCd$JBEmS?8}vd4ByWQ$jn=m5Rl zjZ@cZ`i2H$)7(Dd+3kn}EAbZxBV#wst%={$rKPH#Aqm!JO zD{%jHrt)xd(Sr96WLjv!>?nYcNUw4iY)VZj&0d&-ks@;0Z+;|B_O_{*B6@YQSWnF! zH!{8RSY)$6id_SEEpg1yWh-I&cN`jLLaFmZIx+|(b~QPcJt1_o3?>1`ArrLgudI&J z($YOqnsPlK+6$X+d<}vlWn9Qhd*r(B#W#azNLbEnS87AUUg76W;yfzJ z)&~2FOzN49JkFOJ)^}_t3VTd8H`1JOi61GsBB~Y#-Nh?oeYYmVrE;e;f;4_#%_FIi zZR;l*8w@Y-Z3FQ8H!^vJhWieNud9PTQJ{itH23xyu1gwgzDKw#N|avi*ox3cWnJN) zMB<(`XY1n%?%#EJpOCb={DVy+)}NktK6_2v^Zo3yfCsyL%|Ie?HvLmg)U}pvvNgm5 zGx4I^Jemz_$n*E_x6TfR+L}8bf_x4jCLEU)9Jd7&7Ku=_GSfscGPrvt(~evcFO~4| zM|dJ6r!F|kYC5ZG^7Tg&@_JoPCO78E(j;2<>4Yql$1SZGQwlq)lJk4{bG-8DxmrZ; z70-OPZuY~+FXomn#{$M}lI0d3|B>@-{Cg_YUJo}fq9ixB&i7yEUSO%Nj4wF4wIDuc zQ&kgPx39v&V({3$WRT5DX)VjRrA@5y(oa-^Y*FenC|GT)!RNJhAR7VnP19A2#y0qE zX_?mvZk!j*Treufu|y>>X)Et%rbjG375h!u{ZG7uVDTOu;MMJ@N>p5j=#h932fH&q zn?ad3DlYV_n|d-TiPWn(puSU~U|12KdB|?T{*|bjRZ;ePj*+&VBpX@J$I%j%Zd<7g z=`Qg%9!22Ob|Ees%Y1Ea$!jMY={qxCTdmJE~FgpN$hqe`?~Q%4Lm>ASa%4vOtvMgK6CExWHO zN?_Tx4!5K16A;r=;Mm{Od4TN02wW+BhbuTRN}_w|<`5sytii2SB*gJTNhEcBFC@nK z*b#jgK3rQH+SHM8O>6w1_}GEL@Z|^%{_C5*yS|7;fUZgX5S?=TMU`Xq`0HSE^9xbP z99o!!3kYmG;CfT*9a9mV1}dn&F#mJ4f(&HS--v-3>l>xGoHgrh=?W07 z3#TC5-aDVzNq73K7C=8y-WXuREW1X!vc@o7Q;@4=-gpEtHL)bp^aOnz_*hT@knQcx zm54&W9npERA*fUr{hO%l&SPE*x4})3$pCg-+WCWbH;_m zGi!LR3Z)S|-F>WymjL*XQ&ZGpyfNQ@hnXWwni6TCwG=(3+8uqPzsqmlz&u5I(m_2b zdU?_I#iRKEp&^c9=v_12069zl=pH=l+w1N0 zXJr^6){it4hrHlXj58DTE3oilATM#rhZ8{Z3c3g^?Y4eMumyTFX^t^4=(M zUHMICo_E8FtapV$d8_Y!PPj_JE(xMVTrTJR?^p=#8Elb} zqK=cQd-PR>O3izIl`*|O>e3xada6tumHiO}>qX(TeP1T=Q!bBg>T`H#QqWJAc9fxe z{sIT`Q18ousHgX21SI;YijWzbIK=0D4PZ$Gk0s1XRC0tyr#Il3-GXRFk)TYNz?Q3U}_ zMSCl9By90FwDL|5Xd-?D{)Ur?7GUnb4ttvO`3(RmHh9}P`@N%mUv-pssm+` zyLe-)Ep^szPcrPy;mE4IT6`XvL$Gm!9-QjtyjWO4g=tuR&f)`PQwNWTK#x44p=T>N z%KO`vlZj~BZ>gMtPjn|K>hr9yAH7Ek_hIioOK3Jbq-5k`05umN7B^eRRErb|)H#)w z`5mT~^aD$mU40{Wp0UTQ*2q^1&hccIKdo!w?|qU@=Gm|KAZA5iIC(NV6p=^1I*-2h zS8sBky6rjF%o>)jA<4L!`yE-?dXk{B>4(`*8#WV(;f@<3_3rok;>0`UYl(k;`-2sc zj(V^1FB+ebZ^{fO&BliNk@jWGO`iSzP3ZpPc|uweFwbEt+mDan+;rQs>3MWXYcn~@ zh~w4df4>U+xYCd+L(uD$q&(96V5+R7)B}!mx3Kz2K_?y)_~QaWK_tQM;M7{G`=02V)fLF zIsbM+6_SpiQ^JUj(@SM(!^6z8Zz~sN9#OLs8b$c%PF4B>d zCs+MZ{=?Ey@BtqS@rtjXTUC64dTIU$*>{N7S%uD@#~8MaZ#!zTa*@fi|6z*!8wNSR6w|EXW+tGt#^FD$8TP4i5Gv$}6mJ7u;qr)CpD2B3yZN%uIzC{X?TKNr@jYYkHIY zX!r&leb4JsMg+Nq4k?ghYA@k=Wp{`I6|{C1tB2+NPpf?r^YD>D=Y%yyRB!*iVX5Z& z288H4aiVas)o}_E%>%NpIg)>+=CkYZ!sa~RL8?+4L3?)oYV3Je*# zByEZ)?mZn!m^|Eu&J4-Nwzo>v$gLf$f&D~7(ud@OD>vc%PZyIr*7j?Mrx;sk_A|nk zCkU;@y67LQ{Gqf_`J6k1JDFxh6Tb*#IZ~!!H!5~vN^1o8`A_CHx2p52g=qp`LYNLF zHUX3lT}{PppY6i*pX2Nl#8;zB;I>_Vi^kbQ8GDrpF@Ccq@r>_!4;_5T`G1l5MI^rj z$9r{sIkp&~R~5y`H@o_QJC;`eRV>bJpKJsd*!>~ovF?n|&@@~sbVoAJQ%oBuCZV%2 zHA1Nq$CqtUq?DFSPmQCB@=+a0X_&#a2wYbjwT-jvVrV4=l$$YX+_Z zj}$%I$Ig~xwv*LYg;=%k(SF!b30H|NFV`OtFuEsniX|GYHM55k^F5^H8Q5hz!3r0X zg-5JWQT8i6(?;A~^lYk)Mgo!1ZQ2HWdHhm)f*@CCKlso(^Zr@Bc9JoR%SIlU!WJC6 zfYY^c3+J7ke58XQk_M4F>Nlx%n$~1qqbIzn4J!xg$o?Glr#6|Ji%e(&v5c{Iex3>_ z^YB-tjbc_CUO=&k-hp%dPW~jhgrgX??mSwE+Awi%<~o?A`~m+Brr#x(5mJM)c1!v5 z3fr{|ZjhFI!rga_Z1yKFB@W!=Gey?td~M$GPZjcpA)d;GWGpsvJm)H?5_RUqt0oMy z;3uD;^adch&x^7ci@O)b(BIK5>rB|vPJA8BGnGSe~BbK-Lblyx%r{!m^_S96``Csqu!6Aic z&Xo3BUL~OuWEOQ|Ub0il7d+dK9AsXF9AWe7k9CZK10%0WxQ@5kFE`qt8%yYY({SVQ zBB&-$_i@Pp(~j>=S@CwUQ@p)dH`Uu=kWuhq5HDTW#$rq~V=;QC+R4Jz2=Hhwp|A@( z+`suFZF@7{PLyfi&A3W7$YhxGm9PDv^{w*xLf>Ximh#oH4Q#i-s-%Gl|@1^Bj)3DfsVccN|xVK*}=Zc6`Q z;)%IMXc(1cCnk#Ft8bqw{Rc$z6e#d-DGRmmU+807&fih5+9-eZ|ie&E{}6!#1WDyvbWTS4;n8jXJp=1>6YR zZ`TlEkNPnULT~dgbvW%f@k(vok2Rkah+)0cFZ+#BFuqUQ z^l_>4Kn;ronl;2c^GFa>I$!+jICQ6d*C;t;ri|^h>b~OM|A$7qktX+N;QB&MYyZBT z79pmV0mcqND8EO(F793rQ2|f=9-`d+0-OLKxM1UmgxKGlpMS()bWCg07=Umgg`JSp zT+}-0G!SZ(8b-3u8N&6}6g4_OGt@uU&(cpciqXVs3j=%flmSPoQknl+09xw$Y7MIP G(f4;bzC{0kT$Vwc00y4JSO z;saWt#MkElRi8Y6wk~(G30|YwzyFrAy zRFA*9!^tBrH_Fo3o29FPi;`DjYS7%~==1tOOH*-tgNn4)gR9MEnZmKj-F~dmN>yDk zJw=e3p%_d5DgXch_DMuRR5;7klxvrBFc8O!AY?es;*B-fP$`|zdy3p8vOzdZ+bZDR^1=5dWN zmYmc1d~ziCTp!I*H~5VJi_Z5x&}3N)_TLU{6gK<_X@HLK9v~#w1EJs@_DaTpB|9Kb zCIcJVJOR6V_2B{v$88s^*zFN4UHY2*5@V+(kQ;o6p zLhnoN^fcC)38AeY<>QQ zmOoqTP3`KXpd6(zeX2(dx>;Lieu!#0=ihW1-*w<`Q57@*bS#%aeajF+r2%6o|Nt=lYtNmyxvqVw52R(Jk$m<7#zc&lS SNSUPo0000$Yu5b diff --git a/README.md b/README.md index a059570f9..b7fb227d1 100644 --- a/README.md +++ b/README.md @@ -1,89 +1,114 @@ -| Build | Stable | Weekly Beta | Support Server | -|-------|--------|-------------|----------------| -| [![CI](https://github.com/mihonapp/mihon/actions/workflows/build_push.yml/badge.svg)](https://github.com/mihonapp/mihon/actions/workflows/build_push.yml) | [![stable release](https://img.shields.io/github/release/mihonapp/mihon.svg?maxAge=3600&label=download)](https://github.com/mihonapp/mihon/releases) | [![latest beta build](https://img.shields.io/github/v/release/mihonapp/mihon-preview.svg?maxAge=3600&label=download)](https://github.com/mihonapp/mihon-preview/releases) | [![Discord](https://img.shields.io/discord/1195734228319617024.svg?label=discord&labelColor=7289da&color=2c2f33&style=flat)](https://discord.gg/mihon) | +

+
+ + + +

-# ![app icon](./.github/readme-images/app-icon.png)Mihon -Mihon is a free and open source manga reader for Android 8.0 and above. +

Mihon App

+

Full-featured reader

+

Discover and read manga, webtoons, comics, and more – easier than ever on your Android device.

-## Features +

+ + + + + + +
+ + + +

-Features include: -* Online reading from a variety of sources -* Local reading of downloaded content -* A configurable reader with multiple viewers, reading directions and other settings. -* Tracker support: [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/), [Kitsu](https://kitsu.io/), [MangaUpdates](https://mangaupdates.com), [Shikimori](https://shikimori.one), and [Bangumi](https://bgm.tv/) support -* Categories to organize your library -* Light and dark themes -* Schedule updating your library for new chapters -* Create backups locally to read offline or to your desired cloud service +

Download

-## Download -Get the app from our [releases page](https://github.com/mihonapp/mihon/releases). +

+ + + + + + +
+ Requires Android 8.0 or higher. +

-If you want to try new features before they get to the stable release, you can download the beta version [here](https://github.com/mihonapp/mihon-preview/releases). +

Features

-## Issues, Feature Requests and Contributing +

Features include

+
    +
  • Local reading of content
    • +
  • A configurable reader with multiple viewers, reading directions and other settings.
    • +
  • Tracker support: MyAnimeList, AniList, Kitsu, MangaUpdates, Shikimori, and Bangumi support
    • +
  • Categories to organize your library
    • +
  • Light and dark themes
    • +
  • Schedule updating your library for new chapters
    • +
  • Create backups locally to read offline or to your desired cloud service
    • +
  • and much more...
    • +
      -Please make sure to read the full guidelines. Your issue may be closed without warning if you do not. +

      Contributing

      -
      Issues +

      + Code of conduct + · + Contributing guide + · +

      -1. **Before reporting a new issue, take a look at the [FAQ](https://mihon.app/docs/faq/general), the [changelog](https://mihon.app/changelogs/) and the already opened [issues](https://github.com/mihonapp/mihon/issues).** -2. If you are unsure, ask here: [![Discord](https://img.shields.io/discord/1195734228319617024.svg)](https://discord.gg/mihon) +

      Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

      +

      If you got any questions, join our Discord server.

      + +
      Issues + +1. Before reporting a new issue, take a look at the FAQ, the changelog and the already opened issues. +2. If you are unsure, ask here: Discord
      -
      Bugs +
      Bugs -* Include version (More → About → Version) - * If not latest, try updating, it may have already been solved - * Beta version is equal to the number of commits as seen on the main page -* Include steps to reproduce (if not obvious from description) -* Include screenshot (if needed) -* If it could be device-dependent, try reproducing on another device (if possible) -* Don't group unrelated requests into one issue + Include version (More → About → Version) + If not latest, try updating, it may have already been solved + Beta version is equal to the number of commits as seen on the main page + Include steps to reproduce (if not obvious from description) + Include screenshot (if needed) + If it could be device-dependent, try reproducing on another device (if possible) + +- Don't group unrelated requests into one issue
      -
      Feature Requests +
      Feature requests -* Write a detailed issue, explaining what it should do or how. Avoid writing just "like X app does" -* Include screenshot (if needed) + Write a detailed issue, explaining what it should do or how. Avoid writing just "like X app does" + Include screenshot (if needed) Source requests are not accepted. +
      -
      Contributing +

      Repositories

      -See [CONTRIBUTING.md](./CONTRIBUTING.md). -
      +
      +

      + + Website + +

      +
      -
      Code of Conduct +

      License

      -See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). -
      +
      Copyright © 2024 The Mihon Open Source Project

      This Source Code Form is subject to the terms of the Mozilla Public
      License, v. 2.0. If a copy of the MPL was not distributed with this
      file, You can obtain one at http://mozilla.org/MPL/2.0/.
      -## FAQ +

      Credits

      -[See our website.](https://mihon.app/) -You can also reach out to us on [Discord](https://discord.gg/mihon). - -## License - - Copyright 2015 Javier Tomás - - 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. - -## Disclaimer - -The developer of this application does not have any affiliation with the content providers available. +

      Thank you to all the people who have already contributed!

      +

      + + + +