From fe3b5c2d9c40abc3e5ec4eed0b5766c8357ed28f Mon Sep 17 00:00:00 2001 From: inson1 <75314629+inson1@users.noreply.github.com> Date: Mon, 20 Nov 2023 23:25:28 +0100 Subject: [PATCH] Nicer readme (#2390) * Update README.md * Add files via upload * Delete docs directory * Add files via upload * Update README.md * Update README.md * Update README.md --- README.md | 72 +++++++++++++++++++++++++++ docs/cherrytree-main_window_text.png | Bin 0 -> 135079 bytes 2 files changed, 72 insertions(+) create mode 100644 docs/cherrytree-main_window_text.png diff --git a/README.md b/README.md index 31696780d..5bd23b08b 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,84 @@ A hierarchical note taking application, featuring rich text and syntax highlighting, storing data in either a single file (xml or sqlite) or multiple files and directories. The project home page is [giuspen.net/cherrytree](https://www.giuspen.net/cherrytree/). +Written by Giuseppe Penone (aka giuspen) and Evgenii Gurianov (aka txe). + + + +## Features +- Rich text (foreground color, background color, bold, italic, underline, strikethrough, small, h1, h2, h3, h4, h5, h6, subscript, superscript, monospace) +- Syntax highlighting supporting several programming languages +- Images handling: insertion in the text, edit (resize/rotate), save as png file +- Latex math equations rendering +- Embedded files handling: insertion in the text, save to disk +- Multi-level lists handling (bulleted, numbered, to-do and switch between them, multiline with shift+enter) +- Simple tables handling (cells with plain text), cut/copy/paste row, import/export as csv file +- Codeboxes handling: boxes of plain text (optionally with syntax highlighting) into rich text, import/export as text file +- Execution of the code for code nodes and codeboxes; the terminal and the command per syntax highlighting is configurable in the preferences dialog; an embedded terminal is available on linux and mac os +- Alignment of text, images, tables and codeboxes (left/center/right/fill) +- Hyperlinks associated to text and images (links to webpages, links to nodes/nodes + anchors, links to files, links to folders) +- Spell check (using gspell) +- Intra application copy/paste: supported single images, single codeboxes, single tables and a compound selection of rich text, images, codeboxes and tables +- Cross application copy/paste (tested with libreoffice and gmail): supported single images, single codeboxes, single tables and a compound selection of rich text, images, codeboxes and tables +- Copying a list of files from the file manager and pasting in cherrytree will create a list of links to files, images are recognized and inserted in the text +- Print & save as pdf file of a selection / node / node and subnodes / the whole tree +- Export to html of a selection / node / node and subnodes / the whole tree +- Export to plain text of a selection / node / node and subnodes / the whole tree +- Toc generation for a node / node and subnodes / the whole tree, based on headers h1, h2 and h3 +- Find a node, find in selected node, find in selected node and subnodes, find in all nodes +- Replace in nodes names, replace in selected node, replace in selected node and subnodes, replace in all nodes +- Iteration of the latest find, iteration of the latest replace, iteration of the latest applied text formatting +- Import from html file, import from folder of html files +- Import from plain text file, import from folder of plain text files +- Import from basket, cherrytree, epim html, gnote, keepnote, keynote, knowit, mempad, notecase, rednotebook, tomboy, treepad lite, tuxcards, zim +- Export to cherrytree file of a selection / node / node and subnodes / the whole tree +- Password protection (using http://www.7-zip.org/) available only for storage as single file – NOTE: while a cherrytree password protected document is opened, an unprotected copy is extracted to a temporary -folder of the filesystem; this copy is removed when you close cherrytree +- Tree nodes drag and drop +- Automatic link to web page if writing the URL +- Automatic link to node if writing node name surrounded by [[node name]] + ## Prebuilt binaries Prebuilt binaries can be found on [github.com/giuspen/cherrytree/releases](https://github.com/giuspen/cherrytree/releases) and [giuspen.net/cherrytree/#downl](https://www.giuspen.net/cherrytree/#downl). ## How to build from source code In order to build from the source code, please read [BUILDING.md](BUILDING.md). +## Localization +The following languages are supported (If you want to help translating to your language write me): + +- Armenian (Seda Stamboltsyan, up to date) +- Arabic (TO BE UPDATED) +- Bulgarian (Iliya Nikolaev, up to date) +- Chinese Simplified (Wang Yu, up to date) +- Chinese Traditional (Emer Chen, up to date) +- Croatian (Filip Bakula, TO BE UPDATED) +- Czech (Pavel Fric, up to date) +- Dutch (up to date) +- English (default) +- French (Francis Gernet, up to date) +- Finnish (Henri Kaustinen, TO BE UPDATED) +- German (Matthias Hoffmann, up to date) +- Greek (TO BE UPDATED) +- Hindi India (TO BE UPDATED) +- Hungarian (Stiener Norbert, up to date) +- Italian (Vincenzo Reale, up to date) +- Japanese (Piyo, TO BE UPDATED) +- Kazakh (Viktor Polyanskiy, up to date) +- Kazakh (Latin) (Viktor Polyanskiy, up to date) +- Korean (Sean Lee, up to date) +- Lithuanian (up to date) +- Persian (Majid Abri, up to date) +- Polish (Mariusz Gasperaniec, up to date) +- Portuguese (Rui Santos, TO BE UPDATED) +- Portuguese Brazil (Raysa Dutra, up to date) +- Romanian (Tudor Sprinceana, up to date) +- Russian (Viktor Polyanskiy, up to date) +- Slovenian (Erik Lovrič, up to date) +- Spanish (up to date) +- Swedish (Åke Engelbrektson, up to date) +- Turkish (Ferhat Aydin, up to date) +- Ukrainian (Giuseppe Penone, up to date) + ## Used libraries https://www.gtkmm.org/en/documentation.shtml https://developer-old.gnome.org/gtkmm-tutorial/3.24/ diff --git a/docs/cherrytree-main_window_text.png b/docs/cherrytree-main_window_text.png new file mode 100644 index 0000000000000000000000000000000000000000..b94133041eb6f8c0cb762cfd8768be65bbc6d5b3 GIT binary patch literal 135079 zcmeFYWmH^E(=I%?TX4BXdcXzko?(QxL!GpV7fZ#5{LvqM{Kf1p2=UwYN z|K4E+_U^8_s_N>hp1pfFQ7TH(D2N1z0000*Rz^Y%0DzVT0H74%A>Ue_JtJ5F0MaIJ z4INiCV-KLCvx5cL)*R^Sy6uw`&V)XpD+Gfzr%w9lz#93`rZ=o)QRy~y+b*A zR!t`FxB9aJ@Yv85e4}{yJ44UcFt1YJce#de2u9+!q2u-ZzSz35tN@=`G~K8BP36_K zeazzg=G5
M=ektL_$L`oSuus%H(
z4VfnK2V|YmtQQ%1xcr@jP9Iwnn|_58>JuC%u4deSywBNf?+iU`8*q5osC7BS?BIZf
zMXHJsem(v51LdI#TTF$)!^>polZi${W;k2<@6OoRPhOth%)So~hr(kvWFeBOS~19w
z-CLwu2mz#`-tTfd8m{i3NX~s>ff5^CESZTT09~ZYPy*kW#xM~eKSGv*U>OlEK78rm
z0EKCp<%nWJ7pDVwr;{UXWITQuf}KrOO)+jGmP1x+D(o5DsV?4Jk}OZ#+A=pz(_EHi
zQ`y=^r;@|idZq_%ZCzToYA(<7Ic{y=dO30#Oae@@omdqoupaE?eN3Xh%rjs)jHa*s
z6s_;py11<4qAtXL*>q~(ec5;zMNNG5ePLcn_`3p<6s>NX$zqlpAs2J0`^WC5G<}Ee
z*LeOf=I0-m41fI+UFxT{xgJenvi;UHTwUvjf&on}$xCiLyDu`FttKKWy+84g=%R6u
z!Y)h(QYHJyFt&;?hKE0aW74@p@4?iAuX*sx(94DKcVhcvzQq)+TR=vq;q85Q4e{)Z
zKij=~Vekp&ricEXuH2-5{7& mrBIF(l=
zEY#!sDBTN)fg#BY6~Tdc9S+$Y*e!O#@qR^VmH_U56=J#E{Q6g>yXfhcNoIC&!Ka-|
z()vUgP{&zoDih1roA^Hz6-)yo1I1~FbVcuLQ@CGe31vWB!3$@xwZ@)p^+G` xvKELG7bXR>Yf~_)S#V&u=ZP6RMhCm
z2tb@yr%#}X3jyDShKAPE)J&IX^!D_4dU_hYd48l`{pPnY;TVJe08I5ZX4d2${CWnu
zmmGkng42BabVu>oNHeEvALEI&4?noXM@MHV7fD7ENyp}ne~te{1@tc!sn*#p^9us{
zo-3_D3h2~+#xhtR<@k!RCC1PFB5X+&2m7}AXo(lw>wEoM*DT&MF||5w%K&{N+GRkd
zXl!i!PL?E_-`V-`16I6@>DRBjKtwd-y5&jT(%vd%^C
z;PY=zr-vaD(_0DLxqfEf9plcUUf?7IVOU)0%@7bdw;b3$!;gz4^AJF+*a)n43rMS;
z7&Sl>@~{>QaWtSFXy(^UkjS17SnAA3SJ#K84t7F4+1u4^9$u|3MCb^N$;6c2Zq7XJ
zFBZ)Ygmpy}LVxF2oL!4NR+$Z8Ntu!tLh8FZb_VQvn1U
0*iWblvOnXTV6zxFhv1|Wr<_#oL&tu=E?({DtM
z{Q|}QLTjyn2f3AcJ!yi9<1$NkN6OdR@+-O9Ky*wUGi+Xb_1p#Fq+)tj%xkZ!@#5H<
z+$V*cMbwz9I9b_KhdH!X4O@u{pUSAyMyGTU!<_v(SbyKV2KenAo;I89h*fGJ0=Tlz
zN3Jo~($e5AJ|Du-g4_IlTsQoFzW*M>e{+Aq%w}MhvD&*T{Nap{fH*{Oh?|V(+i`n+
zq;~NyZqO6i+>frlW#ZpthCODWa5VNM5wy0!IuLQa1SVlFf}^d>E^}O((g*j1uf}sA
zXCq~$(*jE#+|DCuB=Hr8N^8GUrt9aE{G_rKV?mY{ZYeY)T>K1|1?XNVFdH
zbmS}!KDi@8B5dr3TPq_hee#P``Lr^cDzIkqn@5p>14g0(rhwbh88kDhkpOL!gjy#&
zz%c<2f
JGFKGE_<(6^dz(-QGb4Yir^W8WJ3@1LLtE-Ntv(aafNtL#
zv!Y42^S5<{Mup7CD`kepgyhsTwKeCzB{zijqC{5f1Rz~Y$*4Tk4ZuN|Bej%igI!fx
zy%~Rhb+6Z_?Hoq2(Dje9F!x73IGJhSk*GamztftN%O?mkuf7pBCq3;~RWoS}y?KRj
zr7s2{dU|}8c)+VrxK+=Yz|uJB1*yBo(>j6K=4D9l=XcmPEsU*y{DzX+Fcy88zWjd}
z`^u=enr2-R5(p3=xCMBF26wmM!QCymGr=8_5Hx6TcXxLQ?(Q-Z+!@?q?w