From e0aad6277db6d3251e40c00849167e3043b9035c Mon Sep 17 00:00:00 2001 From: Nouredeen06 Date: Wed, 1 Apr 2026 22:13:23 +0300 Subject: [PATCH] added readme --- Clario.Desktop/Clario.Desktop.parcel | 2 +- Clario/Assets/logo-textmark-no-bg.png | Bin 0 -> 10301 bytes README.md | 105 +++++++++++++++++++++++++- 3 files changed, 105 insertions(+), 2 deletions(-) create mode 100644 Clario/Assets/logo-textmark-no-bg.png diff --git a/Clario.Desktop/Clario.Desktop.parcel b/Clario.Desktop/Clario.Desktop.parcel index ac44630..74d2da5 100644 --- a/Clario.Desktop/Clario.Desktop.parcel +++ b/Clario.Desktop/Clario.Desktop.parcel @@ -2,7 +2,7 @@ "GeneralSettings": { "NetProjectPath": "Clario.Desktop.csproj", "ApplicationName": "Clario", - "Version": "0.3.0", + "Version": "0.4.0", "PackageName": { "$type": "msbuild", "property": "AssemblyName" diff --git a/Clario/Assets/logo-textmark-no-bg.png b/Clario/Assets/logo-textmark-no-bg.png new file mode 100644 index 0000000000000000000000000000000000000000..6ea0451a40b099fe2e421676435425bdfebae69f GIT binary patch literal 10301 zcmZvCWmsFy^EOi4p?J|ki&G>xv{2kFXrO3uNYSFjp|}MK#hnC#LxM{wR=mMoiWMn^ z;_%P&d%wQ9PI7Xxvy(Zqv$OX-dp_%GtB?>f5Mp3pkf^CD>SJJF8Kb`s;p3t|2Qt1% zqfZ22RZ}kv3?i!k-k2CUxpe3sF}?Iv6fof9&-T$5PaNd6K^ zX-nc^W(Bx%f5-8Hjf(a2(Q(BpG+;E;=wEG2OMO?8^0N}Q?tA5seRI0!9!ID5inb#x zC#HoFn3m7(U6X_=-Y>bI-}ZN(IC?z1R#8+`To5iqIu%OZ6OBafa&I_^5a=+f zhTY`}hOCH4H_AC2;+-OK0h)=BKwIC6`|g^U7S4AQ=09BM5J_`GGA_@*dsU6pQ+7hpgWpHopFah_JJ>=jd?up=wy%M5^=w&6)-nD}UC8 zey&6(rjp&$(~EM(9@E7eSJ2>9zo(#}7^`jCIB?~so@}YlirUvmzw>h!YX3Je68JC+ zY$UdX4+|2Q-JStDtcK8v+syX+Am%zK74!0kd}U0X`!Py-%@)loTxPXN=iv!05jGkeF zhi8wS1ix=h}&@H8Kww5QjnI7+EykzHn5k`&r;O5#NM-Sekp2xhcdP&gREn}_vG zwYjvqm#}AmTg*HZnj87rBAL@5N*b*NTGv;NoOXt2%6CGzd)m2Lk28`1y5v$o#Krt- zvaM@loRXp<&@grcRcXfQWp7Vrl%qY)GS62;iBm#!YC3?n7fL7x8YT&7btRg0$aZCg zs;m_jHpP`44$QZNp)KH;2ct3=8_;3~bJ$~f8Bx=ePxh9#ln9$yr+ zpZJk{qjC9*xSo)&joIW=1pPs*Hr03B6G<&qv;pKG#57~wYOG$kZhgYAQ*ZkG$&|R0 zI!$}G;HH!?+6aFfD)@Oc?@Z|J@Du=I|H79jv&a*mEzaqvJ zjc0jX6`Dk1y23ZI`%-*Ib!6!Fv_H&nP+c6TZZnaFc7nQzGmjY+YVQo%(^gd6*#dy_ zaA0vwre6lv9_57i9o0MkxxSs73%(p`kylhSq+IQTXcHir!ibG_y?w{7w>;v&=VNi~ z5n0RV%%*6+!3lDzo91RS^j2B7|9xKK!ShFCI+2*z1l<=G8N-VU8_jl#5i`cerlFvK z$ip|{dY#1xXa{NK9LtRw)itnb=By|v^ip?d;NE}Qp1?-L@bXliZ4GP>Ru5qED9>4~ z1ljSfWk$rt#&KtX2Q0$8Ud`W6=#)!eZv-&a>JIEHMBJN`xly5gjboc4bkrfY=ViRE zNy$O_?kir_{RyE?#XoJ^U;HPYi;$5j>+V#?UHbSX37Vq zBiMAg^{(SY2L}2cFzsmI?gvSN5m}Yd@F$^3$N#+W1R0;Pbc%gqwLNz2Vh~I0byH*2 z%4kxkyzk}!S>XMz6D2$ipirP^$xujItyEz-SV3fglD$4o?c|?v^y5t2^A9G;7~04m z4hm*P%QNVATSGoN6dG0h1L*RL`$N{+VCw`5m9IEc{Hcbl!8IOGk!tQE(=p{_AFD$n%~gs*b6ud{_UJxrCWYC zy;~gs(*K;BVunyJ$L=od@!n{vpXa_!lrjC<%)55_LcswXbhWtr zp9kbi#rVHeH}defB~HpgRedTShc@kqnTc8HwX z?@OWktv+x-kItlo?{~n!`TaNX<5dIL%r(MKCj}-fT|cxsGUB6Km5oS^#aYZrj7Xlw zFiST6UCQ^zY3p&Jjt|R8;(ZaQzmYsR zC_UfaFO_Yj$cf)97ncJ)ZA_#5SluXb_P)64`4v&9%Mm*aF0p<+2r};uB53 z1f9-=QC2$xTt!UERIp~dnBGX23CgOcTlug)?_?x4QhdtOIjClJvj<(GIpWo6NO=^L zhfyYi49-y$v%)7zV8n+i*CC6@3~f#vz|L&xcGP&&J~$W^t57;> z@m&E(rSYn*chu_L+f41};XE!yV2EK&4nB1R@Rz97K5m%*>oqNGbynMVLhOW))g@dC zxeA|8Gbzn98>4>7u8f9iL{Tt_?{1NCy*%P=@HbeQ`PXxK*Pn&MXPn-U*s-z`PR_nv zQWrzGvf8KiYREE^8cGsH@lrYJ@YW>lVRjQ6T~CDqgv7Wwoo2m3NlVW|t45As zIe_Gour7t(UYhd!NovIW`cXIYqU~x0)V2srJ#b}5Yl&6BzcM@Vvig%+p-m-wv4W}@ zAs{6=u^C{@wuB4pQ_$O=E6`M#6JsL}U}kE)prV*!Z*qnNYOuxsLIV*3Xykyo(D{mJ z$|Ygc6Id|wxrU-*yeE*C?6=u^O#&ByC1W>#d1%y1E zWk$MAJ?Is0?g%X8MJp*nBMovuFH`Y14=Sx*6XreFFfw0oZ73wO;xLspjpXx8%zGOR$c#?l)mT;)HR-y@(N{Nj%+Lm4xl`qS3 zw#7LLEKPh4u(KDkAKHJz&Tf`E2hjQcw_E4>3v2=+&?7BLUw(h#^XwgpL)b|GS=-&h zyp$=Eoo_QR6>e0MB*BEvl(4$hev*D5&W~!)zIA4R`c+}_(D9O5kNw2|9cu-7NgbH&sUL0DZmm>vZ?_*7#&mj_t4$MwnW{uuXad^6E4IxV0PL^0MEGbBSbzppwXn(rEA7JsUQH4~Vpox3}cXeODUMSn0QW#M*M zh=Q6i&Cyq*(H}p}YBHGU7rx}kc+?04X11`?8mB(g#yj)bkJHY_$M4+{gB++CLr#(< z#o-Cstn!2p*dINrcbe>|L6xA367K+TLOJnma8PF9g>Sx(DLQAG3RhfVByX>N#Ng>9 z+ECXIhSpqXDNDjHU&jWUX@I*GazgXBZmn>?7&s z>{S#h`*f-<594g^q|GFWF30vQM_nAv_O1qmHf&*DKye+gQo=%@yuzcp~s8F z6qJsR82_t_mour1lLDT0{G@4P=7yNNbD)JF9^-UTyBhxahyS9*w3)$@wL7|4mfKPW z8~EK6u^8Zb@w*#0DAlUsu-NY-SuG|-L#Fm(yF(<~U)iJCASWz!ap5WqY+Tk_{U{!>UL8&^ZK zB{gjxQRY&eLu`cF=>tx$@x+3C&KK`6(c|{a2Mv>D55=l%eCl&o7m$c$dK0H(*WUE> zSK-tj3ppt${7Zp+{*B#e5GRD|m%hW3NdKwyWr5c-#%Cbd)(X&JUmt(~`!H-R;bXqq zLnHJd5dzai$DaU3)IwhOLtiUpi`aQq2w&0^fTAtet;h+45XQG?vr73x zPV%o`ghpxK81XT7E77>2axc0uOe_>^FUg4xdc^@+PKTT8*AkMOHooXs-`~RPo2w%rbX1EEGohPewfT;XPSx%CkIqtTgK$F&x+gMic;h*^V zN3nO;dt1y(^ONtWzV0pOc#L7-UKy;tYusA^oNxaPxR7d73YM!L_1lpJW$);)zGT-q z?*Pc2TTHxw%$=4S_KK$;s@a}PigjJ>&Zb3ZddRihl=ISt3Y<^=qZ^!Ezbuh;cjs=a z8T6&<-~HBlBj#kdLU;c-nok?i6=-?xE!J=5ov0Ku@p)5K!O(!k&%(2G4o6ew`29!$ z+8DmzKsS!Ylr9;KY`_E@}WK}oL; z?x5fH`wBL$#yXp5whsPeH*dYKDF>gjccS>s)%$@2uLLi8Rx@tG=;$% z{&E&LAhshlm2`V7<--aYk5~i*;j=m7=pltE(BY$yzARC2SSi%c=K~=@*0*fCX?Q?| z)q|Tg0rAs-0QW0=uA88YCRE1PeNtS6-#6yZ$g2mHK=GE3Qc#orEhTFPV<7;7_uV_4 zh)iPA)$3|XTnczB*E36x+{Pg-pmLQ~)qAETOy<+_obFQR`sWjg6{kOdjm}qm;?ws5 zOcMxlxnKt%PnFr=2aG(NUt73#W}UtUF+#q^Rh|N)=1R%2eZ@uU0?I5aq8TK7CV8z+ z(c-Aqk`;%H&Jz~X8p5C{Mt-bf@#zqjf@_d!ax~OjpI(#sWEZ~>)}!xzFlqG;PW{eZ zuHiEEc{FcvoQ6PYI}Sc@cTWqb{>bvT%h4!R?scj26?53CU2_~7UNqvqnN;V9ZQ?Kt z7VxgjS%>DT4K3dE9@&jO>!;R>a%$#5rr-h-zs&6wb5plw75;QO^+o-#k$Ej9iXrSO z=wOJ;a&38Qt%8K;DR`l({ZysHsKgqGHr$u)9S~!B&kaRGMHsMZC`O20Srtd zm`I`ukx!dFJL6=at8IlA{nQ1qiqu8421uu_R?ha6gGxieFK})rE9q=PH7wpZ$I!q$ zSpoNg80}QG9kYr+#>y}CRekTDZ7D6v9)y3P$sn@9R?I+_8~S=P)Kx$KS<0eMWvC`J z`AcB>S`}4ZV_;YLv369Cn)e9m$MLE0GLi)k{De$z0jcNwEuI^a(R=I>_>0=H+>U9b z>#hT#EtKjSdv%ugM7xwD7GRvZF_6!t!BB0N0X>9Cq!dk0jqk?Pj)_ca!aZd{DuYUo z2C6jvRs38j;i@4+79YRk94RhX*A)xTSWyqo-4St-uxo&CwtwgMo{58Xs z6_x!P!AfEyLuc&e(aoOU!jeQrAj(%P@&CpK|M44<4`3R?iCMtKKNBr<>8mRAd<#)UzeGc6*@h!!JM?=Pgf za45whF7~7d|BS)UStqRpj*~nvcPQQ$nV521Ep`3dVqNB=0L=eXqhU z1*vosv^JVlMNGOSG28=^{E_jvaGS*So+-kd3N{M+{&L+sr#?vgE!a1%cO z-8yNkBexXOP|3T>YK~XWz?iqLX2?u+9Nsz8ROiC&3}i@`0BAU4`2_#X0%;oO2vG%g z)erAHU}q9uVfK6gCmzian!Emm>JULaImKhza~U|yay9Xs>zqR?g91Q3A3U+y7SpT{aNdj{Au8gz0>iH!!mgXz8HH2nEOd@~OnkD{PgiHjzk>^a(V?5wQA znb#l&**3-xOycJfPjxK=Olu4k2WVg!;bqY0k=i|~=20!65ou0(08OLoAjjW@&K5{Ed417zr+@+IK|L0UF?tQR+UCEmW z3t27-MQSSgZrZsNm73>brx+$rXJ3^@f4^LZ;=7!7kk$R5hVW9KGDMSPGhYu~7#jjS zKe+VJW>fO@iR$S(l+t_=ss=@U|9Cu-|I7M!w(x^?4!x}M6r_O8@q)+n(?F;agk4br}=nTBHj>dxq5y9cbYFXc2!p@coKw zrm5iKlCojdvr)dhBMQcTAtMY*(AwEPy6}iICOPh-vgi^rM(Bqb*Pb5+j)y`z%b&dD z_79mY5Etm06yL^~pB}?S*FjdvXv(~)t9B{oi1gIzJuS$+Vt9=^2|I4d%?_i-;AFs7azDwFV23FX|@R6@u6d zWsKYxd}3}1G2y2x!#P~fiH-ld^rTBD`)z>B4tzQk!dmRl%DW^8O4~hS)H^@X@y78U z_R+>~o(qc*8!I}U1)R@@D@Y*itH5RE4O*at{od5=@`os3^@8_Cn>&8Wo13Q#AE=ew z9!9p}E4;h?BtQ)}Y(NCl;%qGfR6nk3-LoHQ0aBp) z?$m_wzTITUzd@0M@i1atLOrBs?GZb0A@?c zp!ws+HBaGj60#EIK8Hna#hV<4%^Z#)e}cC%X!|u}rDCWDc(2?NTJ<95G+jU7Dej!( z$ux-FVH)Wp-TP>zW#+ugz-4h#vX!O!={s%3g--D}*~};r%;u6{@-XG(@eR=pSI-ZB z1G?Tl+YnQ5Fhv$mp9QcYcjG2O+svC6E=|MJiI9GXRFGT#a9%yQVv^CIGalSvbzkFB zPrk0@D5^EI5;>z(zvlGOKWLH7n6{acsKvT44LT<)*q<60Ee28U+3q^NShY^o-*GPW zjSGCULF!xmLlO?eP|2FYUejy(3O7NM$FG<2KcW+eBWkX0y6PzHhnez^ktx;( z8(rVe<#szAtqe$w7eS&8QRbh3HwIlQGoPXefVRIG@*~DS&>GhT01{zlAJkJuYOxEp zD8KT{_C?Z&@?`iRn%AT=%SrM!YlRbM90vErWN;g?k z*PZG?LHwl8wgYJOC#T<(5nX$m*-Z|d5u+ikC# zBSEMbo`6ZZL2=p7Lx~iZJM)jFb1X;kl{nN-6y7_?^)=3~|K3dvKu6 zcwyG&&fVbaY!5JVAQ$m;dEdqCZR??RikkOZCcgxzd z;XC76IEwIVem(nd!iC9qewuUpy~$@c-5ZA&wP?b4M2>50R(HKt(7k#hLSU>;ix`da zSYoQ6oQHReLXA8dP4?M?XLywe4@0o0#hxFK0wI zn&LLI0jr|vZ@)oPJbYe9>gg3W-7SZE1T6OUSXgwkIArPPGR~_np+0ITXjHYp^ziwf#TU%*!(!(O&U9eB1?Qe!q#PEk~AQ*2M&0R^FIN*$QRadEB^ zFH5$sZ|3ZUTbY+uQoDT^uukHvqGhm8TmsH&RKpW>-+!nRF`GkpkrNwWXEPIeH4M%DF%4Jd$otOoo|0 z-MqZk8$7?Ci$F>I)H}(9tJTxGs7dwCvC+hwLa(#_zVynfetjtSm~#Gq2Y|QSf() zJvOK~3Jq%NgmPA2`;l<1A3iofA!oC@rc0tfZCsznymds*@|bj*SlSUAjn1UH#2yO7 za9`w`o z{Hc9QS!c;n!=TR;hL)v^Pck%fuakFdv%{z#P36_|*|$PPchq%qG)d^fEM&isyZ~|Y zyUp4xzfnJ|GifGFC=K?PX$fXNGkyOn1I1g+GsBL9XSy(Ln&p3NEgyyUOdaXv51&p7 zTcv6qyD*Q`$J-i6d=M;$FZ)NP^`!4G8E!mwyac@-2DY^ZMLYrFM)ZE4a(B z=6rn!my5Bj1sY9D4BVI^I0{*2Ek zhFdmPY^!sckT=`!<7<7iB_h$o3N4-TDO?*g&mKS$<=F37l@S8?5!DjE#;Zh;K5qTk zS^kk)mF@J?>wNWQOK14 zLlt^FhN+y)Bi=%0Za6^&b!JSDKXnHHz?}*_*)02Q=*;ZzdgZ2EU{Vfmj$Sj*;h|EI zxey;O0cinxLdS^z#>Tj0Fmlnh{xi$M-x0!x*&!Iz@-=U7G{TKa*yTrYc%ILc2uGcTJrCBG z@`Q-rQa0pk3^}vi5y9GZ1w7SdDJ+h%WdF*q22DQSij!E+VV~0l=yZU zNPCGA;x)*~{39RD*r_aR;kdG19M<6|oq~V+jD!3dz~H?v=rI?u9}sX7UsedNN%AWK zy(H!Wm~AMKtf@{qDdLj2Or@MQr$!3iqfFLo8S}o*H%c77S_6FNUq5nsU0@mmq_Vd+ z98UCp;<8-GKBf*QrI7+rsTvYfjXE+6bxp4KWe~R|y|p~(1MkQ;x{2Rl-`Orc!sbq2 zdT<$Xq(=~b8y-OAlDtrkh@T3TN6JT#(%A5N>;z|@-G1AZ)2rXVKdSAvd#{3P>7W#C zy=PY1^QyyWsJWNH7(_=yW48{>D8}mlZy#vq{o&{P_ltw3p#Pp|`v1JlrXH~cwWXXN UnhZ41PxoP{DQPRh6|BPl51N<4MgRZ+ literal 0 HcmV?d00001 diff --git a/README.md b/README.md index fce02bc..b6365e4 100644 --- a/README.md +++ b/README.md @@ -1 +1,104 @@ -# Clario \ No newline at end of file +
+ +Clario Logo + +# Clario + +**A clean, fast personal finance tracker for the desktop.** + +[![Beta](https://img.shields.io/badge/status-beta-f59e0b?style=flat-square)](https://github.com/yourusername/clario) +[![Built with Avalonia](https://img.shields.io/badge/built%20with-Avalonia%20UI-8b5cf6?style=flat-square)](https://avaloniaui.net/) +[![.NET](https://img.shields.io/badge/.NET-8.0-512bd4?style=flat-square)](https://dotnet.microsoft.com/) +[![License](https://img.shields.io/badge/license-MIT-22c55e?style=flat-square)](./LICENSE) + +
+ +--- + +> ⚠️ **Clario is currently in beta.** Expect rough edges. Feedback and bug reports are welcome. + +--- + +## Overview + +Clario is a native desktop app for tracking personal finances — expenses, income, and budgets — without the clutter of a browser tab. Built with [Avalonia UI](https://avaloniaui.net/), it runs natively on Windows, macOS, and Linux. + +--- + +## Screenshots + +> _Screenshots coming soon. The UI is still being polished._ + + + +--- + +## Features + +- 📋 **Expense & income tracking** — Log transactions with categories, amounts, dates, and notes +- 📅 **Date range filtering** — Quickly slice your data by day, week, month, or custom range +- 🏷️ **Categories** — Organize transactions with custom categories and icons +- 📊 **Spending overview** — At-a-glance summaries of where your money is going +- 🌙 **Dark-first UI** — Designed for dark mode from the ground up +- 🖥️ **Cross-platform** — Runs natively on Windows, macOS, and Linux + +--- + +## Tech Stack + +| Layer | Technology | +|---|---| +| UI Framework | [Avalonia UI 11](https://avaloniaui.net/) | +| Language | C# / .NET 8 | +| Architecture | MVVM | +| Icons | [Lucide](https://lucide.dev/) | + +--- + +## Getting Started + +Download the latest release for your platform from the [Releases](https://github.com/yourusername/clario/releases) tab and run the installer. + +If you'd prefer to run from source: + +```bash +git clone https://github.com/yourusername/clario.git +cd clario +dotnet run --project Clario +``` + +> Requires the [.NET 8 SDK](https://dotnet.microsoft.com/download) when running from source. + +--- + +## Project Status + +Clario is in active development. Core tracking features work, but some things are still being built out: + +- [x] Transaction entry & editing +- [x] Category management +- [x] Date range picker +- [x] Expense list with filtering +- [x] Budget goals +- [ ] Budget goal notifications +- [ ] Charts & reports +- [ ] CSV import / export +- [ ] Recurring transactions + +--- + +## Contributing + +The project isn't formally open to contributions yet while the core is still being shaped, but feel free to open an issue if you find a bug or have a suggestion. + +--- + +
+ +Made with ☕ and Avalonia UI. + +
\ No newline at end of file