From d313634570ffe46a3ba9ba062e98f426e08e3cef Mon Sep 17 00:00:00 2001 From: Chelsea486MHz Date: Mon, 25 Dec 2023 12:43:21 +0100 Subject: [PATCH] Added docs --- CODE_OF_CONDUCT.md | 1 + CONTRIBUTING.md | 1 + README.md | 39 ++++++++++++++++++++++++++++++++++++++- docs/logo.png | Bin 0 -> 6819 bytes 4 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 docs/logo.png diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9c3d7e4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +Be nice. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..98494f9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +Contributions are welcome. \ No newline at end of file diff --git a/README.md b/README.md index 5484c17..d086d93 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ +![](./docs/logo.png) + # stargazer -Framework for hardware-agnostic, massively distributed N-body processing + +**Status (master branch)** + +![](https://img.shields.io/badge/maintained-yes-green) ![](https://img.shields.io/badge/license-MIT-blue) + +--- + +**What is Stargazer Framework ?** + +Stargazer Framework is an open source system for building an entire hardware-agnostic, massively distributed N-body processing super-cluster from the comfort of your chair. + +**Architecture** + +Stargazer Framework is built around a hardware-agnostic compute server that can be deployed on just about anything. Live telemetry from manager nodes allow for near-instantaneous workload adjustments, allowing each machine to contribute their best to the cluster. + +All computations can be easily modified, allowing for new mathematical models to be easily deployed and shared. + +**Installation guide** + +See [installation.md](./docs/installation.md) + +**Configuration guide** + +See [configuration.md](./docs/configuration.md) + +**Contributions** + +See [CONTRIBUTING.md](./contributing.md) + +**Code of conduct** + +See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) + +**Active contributors** + +Chelsea Murgia ([email](mailto:mail@chelsea486mhz.fr)) \ No newline at end of file diff --git a/docs/logo.png b/docs/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..446755aa4abdf7076559fccf0b01262a6b3064c8 GIT binary patch literal 6819 zcmbVRcQ_o*(-#p$)TnWK?=9-#ltc7#qW5wMqJ%^A5}ibMdMBcH(MxovpMF9Fr+1>u z&-efLulLz!cJ`Uw*?DI6d3I+$8>OxJh5(Nm4+8^(Kt)*rf`Rcw`i(Zf`!-e-lPr_W1bH1OH|55)cLk^fa=2_6w(n1rlKh(fQPJb5uT=A=_ zn4Kte{-a7x!3@EH5?Z}vQ^p{AK2niT7;51lC-mVEP<}(f5&b5qYaBaVT*$V6kF=4; zOc#PIDA_>N=DYpNElJOzs`mKwEbqR*4iw(gf|Fu~xRI!>7~vGpSu2}7rerNC<)8Wl z$hgE^Hu>oKYx3po#}K0F@4^N-3#FboXB-v8*ypv!k#3=Ariih|r*uO|m)X5Z-sy;sh% znI#6QoLJ#sHs~FRH5~=qGDpb7whK6lJ@`zS-PXf_lx*Ty_&puN8iJ3c-ec+TnZIcI zhApy>(pCP08{-#FPoy!{J~o!n0(?@733XBJK7QRgkt3D6`g(PA|FIngY_&h#+7CE8 z8<(6ol)4=sm2A^1mLt)|B734J`~PMOn79?4_b$j<5u1ZMHQl?f8vL_w9(S82F;wNJ zHa|VB?vl<9a4##}R0qI-_vicHco4U-Z@F)~WSX5blc(vUgP4fF zcC)l9*akPgmifgXoNRL6Qm>nVz!uncfMnTN}P`HPrC z%Yo8-sc7xy$YSxlZGzq);OtVDxSYEp_qK&wWu5$qqNN-$ho%GaQp@=>W^ZRcdVY@o zev8e_QKqW>n#iGYF=$Hszcq%OrR=!Y_dl!AWri~U=wYtK%mNMgwS9B^9s0&81*aBX zYhgRSM;!)c?Ov|>6C(4bx@P_tv$Kc4+RAb0ycq0Pju&cebcg)@M6oB1Oe9Z{D&`4b zD!NQgX!?!WUsU*Q4m)^HtQB0S?F*!$0X`$`h);e$j9V^Te32S+***bxS0_6rE*<1= zX;>~7Y~r5%I4Uj4$uN7v+Q<+of(*hX0|Yej;#T}SRB#z{4sXk85!Ow(sF!(NsC0kZ zvXzs`+^|>O)!BM70LYYyPs6A8KTo(T-HPsp%jYc|!w&Ace1q!<)HRDh3qMz%-I>zekreLIS$hdZ%X3_^+8JtY-fkfWedZTnEH@$l zY56i!nM*{xW5`wlc>F02q4;xxXlu~H$soPOQdi)=-#+D-(XyOabxG8?1Rx8>C*=vn z1_0fN7Dn!3Mkk*1t>RSBDnT$Kdac(AmP`b?vOM-PR=L+}V$#M8b`<*ren;hoZD?P*0XSw(gzA=DRkd0GRH|x8yU24 z5SMFhGhv30(g$3vE#n<{%$phfazpUW=7S?Xqk_szdI0i=uCvYpyV27JY1+P z?BQ&PC1uxC*UAM+Ba=4&Q%w)(LsX!`Y3byTI&YmXhS_sR-Q_{1Z2;%y{Allm8gmor zs^&D`P^Z9u_m}UHUoO7S%`R|a z*K+>5SY+z%a3^=T(&5Xkk}-dg7J%(>jWvX4Ezaf5;lc z>i0XPZV6zlU)k&2BV~Nsh~%3Q&#R5RULDGfq*f-noBY_V+`s^8`FMt>uZlDyOVqQ# zbi0A)Q*SzooZB=xT(FT`!pKb*5Pnf-&G_&2NCs%wF6ZW%=^yUel+$#v&4s8L2p2x@ z>-&9EJN*x!_^G9xz@~5g3WRGMG-a!e^X8I>XaGrXNVSlRL^+c9-0D#XcWHvrNrm z0bo)h6DZv^*DhFCc=n-6`kPl9ZiQ0UbZ?RMp^C8vmGfG7uPI7^y5&Q^Hl|o@bzy;U zxOwv$$)u|_CXZmeWO%r!dAo*UTFo;sXLPhKEiY5GO0M_ zUh8ezi@lfdszr-nmJ^2pnraN8%Ph|+r%~94Q*1E6)#i^QL?C(S8Gd5wp^CEDC3m%0ZaH~Fl`$(h zHnFl|hB5EaH5RA8$qz>wZd_!u=uh(`D)W8qQ8GzC3(mndC< z)9+BB(+_zVH?2=Uj=z8kgu*HEG{&#bw%$+O{yoUdzSR`?+TEfLBN;N_d)uj{WMb?I z0f#X(5&x^%H0jdY0!1?|${UCgrZQz4K+HbB9zV6&P~nY{ods~Uuc27F9*6^wD7*B6xa}`u2ffTH8sMb>tqz(MEE`>B1qUP!0vr}ptRv~$z*uyX>gWyMAP!M`*eJzSwA_KatC$vrJ% z59a4Kf{@-rjNC@i>p%A*o)fnHMAd{A(id;_(;*9Kza)!tnqZy~P}nAN5iawd=02CB zeyskNd%0zcqSUl}$RR^U+fk=4vUk9dv^wt9>R(jff~o9jO6uk37)Sq2aQJTLX$vws zftoB#G1XTYcF*|xu+xD8={rro#A;$?Puc^{Z65x2=Q)} z=Z=vg8Khw0+Obs7JFi+fb&P~5^ z?Kg{rvrPEiEF^_+VFXE6YT39&V_(ALFQ6Q4xFaZK#q+()9Z>6=kq?I^*?* z0GC3<WT16V$l7T7Ybmn@8y(0~ zuB48@`sXz5Ukeqs&rq0#R=iW;AX~Sz;8uD4E4OX3>3pd4evwdB9IOSxQK@F|%gJZp zPmI{-J}kq}%Vp2L=w=&lMi;fqSi8T{UHMZqH<~>=_X->}|DwOMDzmkSE~c`Eje~_& z2^DQas9~&;-%DnQf$yf=-`rHl6GslTc*v&>Wqoq{m*Hl50Tkr|P{EvUl1fGtx_`BY z)j(g(>o~_pm_%}~GWAiiiv$HZy4xTg<%#FZHU>+f zjpnP&+PsW=cv(c3{m#bfnU0ZeB+Nk43VIbDe-pxw`p_V9+g@_lhWNC3k7Os;glBZ3 zEF9^pVWhi1Mc!vK5;l$Q0j;Z&Jf5C4MZ9na=giC+r_xFM>8KVP){(P+Rh;Eya#2;O zwXf?mW*{DN@GVixEOUa=d1WC*yq?a`Vjs(~z=cE>7{(+sGW|IT2oW>NJt9|_zGt2v zDbq4=_cCmoB(>FeZ;V1oO===%Fdo9_1S}=V|1_yBYb(Ux`F;`u{{tJG@^;uy=|18aF}tQ=CzO zk+DBzU@JJZ4DiXkwg$^%fSB0cZ<3R$pliBBs?#7U!&qPe?~Df8W0;5h2$|CR3I9@F zU#(X0`36f!U+hUYrOQ)%tL90(QHjw^JeGqpub4?=%h~(Me9J^~`W}gx~mw(Sp zvUuA1N0wre6xB2-M{N0AR_2TxWtafodehy`xaY#;bA@AO1x>F$3-=f>xawBL*9lXA zTI0yeN}4$_D=~U(jD|FU>CQXccc%A&41`24BHn^q^vlTA!OiWaE#2 zti^T-LLY?&OjM(B4e|>WF|u=dwZz+F8wAH6AyhqmvCc=S5cRe{H;@`x} zqSfienB<9}-QOeBk7YvIltu<4lO~5uab37xxpnfwU`=1e@wpB3^|N4R81hvwcPC+{ zKL$8dDqWGv_u<>k$4(9Q=Jm-t^?}TeD{$SN$22~Z#;O<*x-%U#9H3d@BEdk>AXmsF zQo-W9*^%OfJhGjbk7>`hl{@OvDRWB9P*aJ|o)DYR(_BX|35b`9&?|s05nLM=tI+&y zEuiT2x&|w&=-& zX<4kXCW#>#mJfR)ch|kuUpCFk5H=2>=C?O*Bs~^zb z#;IsorT-MZw7N*>AfACBi;@Yx`I10P0$nTZ9yO}MgI!hHa=_h(g9?v zh;{JKL3N$p#L7}^p&qL!C+AtdfqXKo<{_8$$c}-Q)s>Ug>a5(})e>axa@U~GFMl_< z0o!cwt#bqXY?c*SbVudQLkS7@)^SmlEbf#N+YFuQsY53~HPYXK?jFVh&9cl}+E-Y@ z8q7v4rG;X*ESi0aTW{mKsQh?2%Qd!=s?D>iDxJ4c@YL31anFFrT}Lre|L~z0=dMeZqu4~^D+c=^8Qz)pxWQ3h@SW0lKoo$l$ogqN? zjrz*5WH*z@2J=tQC1K1^%XeCfhaO1%_m6w4ynO}o^@&DW59{DZbbt;o=SSLyD`n;l z4TR>xH?H9r+QdFmo3KVBR+a@p5ONfSeJOn zRBA?laQse;&*v9B-QgP^3J4Hr=WEwKOeM(9G4>rdPdgdWzT%+9kOKiiVeebLS`@BD(LultT+46IO(TWB5d+t$!V2? zpVgmT4a>W*QY829cBgcRQKz)4l^JF)TL8_98wm~K=eG6AvinqDv?S_c-@Xti*0gvP zZ;zKh5FZj%qLus7o&`yjt+s8Il&;`VTTS%ylb{+FF)ALcBTnR!q8OCCN9qPnY8bWB z<9gz1#~I;R!CXubV?5CJx|o);FUH3(cAlyDFcDhtcm*a)U!K`z^ZmO)Er#dSou;6= zm;?WM#;zTCE-&=~fF;GUYTO%tTi)Ya}a{2+)+Jxy!65L(oHQ{I$; zq~nExM2c{3Rk>J236}V}HS*RLU7x}P?ZnroI+^_onfvYc6(ETC5l{}2*j1%t$q~z{ zKAi+Cu)ol%1pk3fA^i@T|+yx7o@pr0Bl>NmHjfj1k@^*gz<;oD4U&yY4*o<`wa|sAk6( z^CyVkfUoPier?nzg+|6iX;n`OZ=32(guXlCwb<9#)g4WKh8YYE(W};moDGX1CsiQ1 z52c% zGC`{;Sm8r2_pJQb6!z{jqx^a0xfj;!BK3_LXxd%B*qPtDaFoyoC)18uhl7Jar!h2Q zavs4hRw10rW+L`g>~(~HC%i7C{tLg0Dz)VMTz##`9Jfe{L>UpSA(4;6=%>;1Ln#yF zTKfqribSb*RVT0_QM23T^3jIV9Onl!t8AakzG=e+D&pJU& zpjW+f?6b#)lxXjkPngiBwEdm;9wI+hSU0YLA^Yx}9%=~oVn6kC(SqkGo5=KDum#;r zub()MM4I?dyq{o}e!TF}rpe7GtR6>9B^ra1?t8~b{WN_%|9MC6cGrs-y3A^2J$~Q% zP36$Wxmg{rB)Y~!284#|O`#lySS^c$XX}EV?9g@_ILJ4jc+sUGPL^PrF|tl!-$h@U66NZ&$9Rr z;_{zCjkzBnz2BC?b7nZgk1a1SOh_%HSR79(mngA%S*b#el^zY(F-~UB(2(xf_#CChd6_AHOUzfx z`Ol=R46Zv{;03MSc$m><0)|^g{-_yGP`I860M2#@@;6U3~ExxO`tZOj+lAWD?^hJOMbCIWUErZzn zwZ5>wNr@;(n}$yd#`PGWE8+!xIQ5##%5T@5#