From 312d91ccb740c7f03096ba513c6ddd872af5ac9f Mon Sep 17 00:00:00 2001 From: Anna Date: Mon, 19 Dec 2022 13:33:26 +0100 Subject: [PATCH] Readme changes --- README.md | 165 ++++++++++++++++++++++++++------------ freeDSP_LOGO_white_sm.png | Bin 0 -> 3740 bytes 2 files changed, 113 insertions(+), 52 deletions(-) create mode 100644 freeDSP_LOGO_white_sm.png diff --git a/README.md b/README.md index 0ad3994..9e34143 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,136 @@ # freeDSP CLASSIC SMD -BOARD STATUS: READY TO BE BUILT - SMD update of the freeDSP CLASSIC. -LICENCE: Creative Commons Attribution Share-Alike 4.0 license - -http://freedsp.cc +**BOARD STATUS:** ✅ READY TO BE BUILT ## About -The freeDSP is an open-source digital signal processor family for the do-it-yourself community. The applications range from active loudspeaker concepts (digital crossovers, bass enhancement, ...) and room equalization over advanced musical effect processors to car audio signal processing. +The freeDSP is an open-source digital signal processor family for the do-it-yourself community. The applications range from active loudspeaker concepts (digital crossovers, bass enhancement, ...) and room equalization over advanced musical effect processors to car audio signal processing. This _freeDSP Classic SMD-B_ is a updated SMD version of the original _freeDSP Classic_ with a few improvements/changes. + This board has been designed using the Cross-Platform Open Source Tool [KiCad](http://kicad.org/). -More informations kann be found on the [freeDSP website](http://freedsp.cc) +More information can be found on the [freeDSP website](http://freedsp.cc) You can find a PDF version of the schematic in the SOURCES folder (freeDSP_Classic_SMD.pdf) ## Links -#### FreeDSP Website -[http://freedsp.cc/](http://freedsp.cc) +### FreeDSP -#### Documentation -[Google Doc](https://docs.google.com/document/d/1K3joEg4iIRMazfqGLaVoBdybitr4o_KIVZfQ-qeNDzs/edit?usp=sharing) +Website: [http://freedsp.cc/](http://freedsp.cc) +FreeDSP Guidelines: [freedsp wiki - freeDSP-Guidelines](https://github.com/freeDSP/WIKI-AND-GENERAL-TOPICS/wiki/freeDSP-Guidelines) -#### FreeDSP Guidelines -https://github.com/freeDSP/WIKI-AND-GENERAL-TOPICS/wiki/freeDSP-Guidelines +### Documentation +[Getting Started (Google Doc)](https://docs.google.com/document/d/1K3joEg4iIRMazfqGLaVoBdybitr4o_KIVZfQ-qeNDzs/preview) +[Getting Started (PDF Download)](https://docs.google.com/document/d/1K3joEg4iIRMazfqGLaVoBdybitr4o_KIVZfQ-qeNDzs/export?format=pdf) +[Schematic (PDF)](./SOURCES/freeDSP_Classic_SMD.pdf) +[Bill Of Materials (CSV)](./GERBER/freeDSP_Classic_SMD_BOM.csv) ## Git usage -#### How to setup local repository -- Change to your FreeDSP directory -- Clone the repository (including submodule) - `git clone --recursive https://github.com/freeDSP/freeDSP-CLASSIC-SMD-B.git` -- Change to the newly created Classic-SMD-B directory -- Checkout a branch for the library submodule, if you want to modify it as well - `git submodule foreach 'git checkout 'master''` -- Open the project file in KiCad - -#### How to update the local copy -- To update the project - `git pull` -- To update the library - `git submodule update --remote --merge` - -#### To commit and push local changes -- If you modified something in the LIBRARY folder, change to the LIBRARY folder and run - `git add .` (Only required if files were added) - `git commit -am "Message"` (Describe what you changed) -- Change to the project root directory and run - `git add .` (Only required if files were added) - `git commit -am "Message"` (Describe what you changed) -- In the project directory run - `git push --recurse-submodule=on-demand` - -#### Define alias to make things shorter -- In the project directory run - `git config alias.supdate 'submodule update --remote --merge'` - `git config alias.spush 'push --recurse-submodules=on-demand'` -- Afterwards you can use `git supdate` to update the submodule and `git spush` to push any commited changes - -#### Other useful commands -- `git status` - Shows general information about the current branch, uncommited changes, not yet added new files and more -- `git diff` - Shows uncommited changes -- `git reset --hard origin/master` - Reset all files to the current status of the dev-hs-01 branch on the Github repository - **Careful** This deletes all local changes, so make sure all changes you made and you do not want to delete are pushed to the remote repository +### How to setup local repository + +1. Change to your FreeDSP directory. This may be any directory you'd like to clone the repository to. +2. Clone the repository (including submodule) + `git clone --recursive https://github.com/freeDSP/freeDSP-CLASSIC-SMD-B.git` +3. Change to the newly created Classic-SMD-B directory +4. Checkout a branch for the library submodule, if you want to modify it as well + `git submodule foreach 'git checkout 'master''` +5. Open the project file in KiCad + +**❔Note:** If you (accidentally) clone the repository without `--recursive`, initialise the `freeDSP/freeDSP-KiCadLibrary` submodule with `git submodule init ./LIBRARY`. + +### Updating your local copy + +1. To update the project + `git pull` +2. To update the library + `git submodule update --remote --merge` + +### Committing and pushing local changes + +This step requires you to have push access to the repository. If you do not have this, [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#about-forks). + +For ease of development, please use a separate branch (on your fork) to propose changes: + +1. Create a new branch: git branch newfeature. +2. Checkout new branch: (this will not reset your work.) git checkout newfeature. + +Then, continue to commit your changes: + +1. If you modified something in the LIBRARY folder, change to the LIBRARY folder and run + `git add .` (Only required if files were added) + `git commit -am "Message"` (Describe what you changed) +2. Change to the project root directory and run + `git add .` (Only required if files were added) + `git commit -am "Message"` (Describe what you changed) +3. In the project directory, run + `git push --recurse-submodule=on-demand` + +### Suggesting changes + +To suggest changes from your fork and/or branch to [freeDSP][]/[freeDSP-CLASSIC-SMD-B][], follow the instructions that apply to you. + +From a fork repository (outside contributors): + +1. Navigate to the `Pull requests` page of your fork, and click "New pull request" +2. Review the changes in the differential below. Ideally, there are no merge conflicts, and you are "✅ Able to merge". + If you see no changes or differential, follow the steps outlined for the project contributors below. + if there are any merge conflicts, resolve these. See [Contributing to projects][docs-contrib] for more help. +3. Click "Create pull request" and enter + - **Title** describing your suggestion briefly + - **Comment** describing your suggestions one-by-one, or more in-depth +4. Click "Create pull request" once again. Your pull request will now be made. + +From the main repository (for project contributors): + +1. Navigate to the [pull requests][freedsp-pulls] page and click "New pull request" +2. Click "compare across forks" immediately below "Compare changes" if necessary. +3. Create a new pull request + - select "master" as "base:" + - select your branch on your fork as "compare:" +4. Review the changes in the differential below. Ideally, there are no merge conflicts, and you are "✅ Able to merge". + If there are any merge conflicts, resolve these. See [Contributing to projects][docs-contrib] for more help. +5. Click "Create pull request" and enter + - **Title** describing your suggestion briefly + - **Comment** describing your suggestions one-by-one, or more in-depth +6. Click "Create pull request" once again. Your pull request will now be made. + +### Define alias to make things shorter (optional) + +Change to the project root and run + +`git config alias.supdate 'submodule update --remote --merge'` +`git config alias.spush 'push --recurse-submodules=on-demand'` + +Afterwards, you can use `git supdate` to update the submodule and `git spush` to push any commited changes + +### Other useful commands + +`git status` +Shows general information about the current branch, uncommited changes, not yet added new files and more + +`git diff` +Shows uncommited changes + +`git reset --hard origin/master` +Resets all files to the current status of the dev-hs-01 branch on the Github repository + **⚠️ Warning** - This deletes all local changes, so make sure all changes you made and you do not want to delete are pushed to the remote repository + +## License + +[Creative Commons Attribution Share-Alike 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/) +[Local license file](./LICENCE) + +![FreeDSP Logo](./freeDSP_LOGO_white_sm.png) +2019 ©️ [FreeDSP project](http://freedsp.cc) + +[freeDSP]: https://github.com/freeDSP +[freeDSP-CLASSIC-SMD-B]: https://github.com/freeDSP/freeDSP-CLASSIC-SMD-B +[docs-contrib]:https://docs.github.com/en/get-started/quickstart/contributing-to-projects +[freedsp-pulls]:https://github.com/freeDSP/freeDSP-CLASSIC-SMD-B/pulls diff --git a/freeDSP_LOGO_white_sm.png b/freeDSP_LOGO_white_sm.png new file mode 100644 index 0000000000000000000000000000000000000000..59d07db8e93498104dab3cf464a2e7dc576b1cfc GIT binary patch literal 3740 zcmV;N4rB3&P)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D02y>eSaefwW^{L9 za%BKPWN%_+AW3auXJt}lVPtu6$z?nM01gaEL_t(|UhSLT!-e+SJP(T3%6i`3` z1r)H)!_;o4FnhLPRaEvL7K>Sf`}Na8K`WHZ=Yp<$lMKFZ<@=mfq@*XT{O5>Lltf$1 z=&SArp)Y8hw`inGXqXCF!8?LWD0P?&)7v0~C<|BPmNg zWf`GG9%MDb`OlV)vTb7-<(H|qfINeGEvI1?&_F-Xq6Cne&}^ zkktrPFn9+eV0RYd1#|%E;55!6Xs8xBfFDEH#hU%9;50hi1no~CqY=)3uKy7%iq6q& z0X+yti7_FZ32}$|M z8b4Ebw(pX|$oD9m%i+r$K?;bwgRr6G-_|1k29tBZVU?jR1P;@pb|@ptf9Kash%D8T z0&)PAKb!_yP6HgPMQI@X7Q(L~uGIUhG?X-G8e*~74Z&dWX3h3FkpFYY`y-n5fHI2l zjiH<$x{?gjam5eI4)rxafR6hM2ACaGbO1xSk;bUT?{su3eJc%fE_|aC$sbb)-w(GK zx5O2BfqW;r9@1=I#S@f$v-bO8xON@*kFS<-xb~&NwgUHRZvh%q_+X5~*;wEP;A=6s zS+EP>$BA4Zy`Qik(dK&lCMdfcRPWZTA3TTczSD7Cefe)uQma`H z0-^Gs}wHv?&y^Q2L11xtrm#U=4&VG3Mb0%fZ@zr;x@n zSJL-D84tr*AFqRCkbfKbcc6E)D3cL}?xo@{(X1EBcvbuSuxWZ#xH`GfoZA+|{59TF zl`=xoPu!4pShhNH`ozdvnsspJvjdI`nCdrls!4RK5;SHp!Z_6X{msbOpH~@a*I{?9 z42`#9#?|OM1y%hWZS6YSuk9q~T8j70qDcApX=nI%Ix1Vb(!*5fBr5kfF+$uC&{||) zlQ{UB@E;Cs(!5;3i4pqFHt1Z6o{MyxZ)vdy#G#{^*FtNF=i7NxAf*ZuzY$7o2yz8! z$Sz$*`wSg70jasei1&NS;G1{C3{V>6zR7!m~Fs~tWWx!G|n3i!4Hd{u?0>raAB%kukR)#gNq5KBRHddi; z3i?9C4W#G{5a#;hZi+q{elYaSBsv)JgOq8K8^Z==+#FzYSdvCCx+rAbts>`Y(yQ4*#dndp>$o>0RiN zOa`d2HrW6LzDCH9(Cr(NdC!Fo#sL3Drcz8S9kI6d^RapLp$qA^OlSFdB{Hmjzzhbt z+1=GgIWC7bB+)z2WF725TU*=nG+Lsf@gJkT4rqi8+M5P+mJ+`|?mf6N_2vbn85H9{ z@6G64hjC?I_uKX;;xrI{KJkx*ilIasbrtAT=zc)63HTZzab<_rEinFHjWxTAs}2w- zGM(wWZq=Xzm>1{ro&N~kNk~UvRR4pFdRnwsP*hYTXQ#=pMm$F?)bBR!^@DU;A$i!a zRs{J5#wDZpQ_aoI-*6@E&~3jQoBLiK>@F1>1A)L|?N1=XNZ38dIU|ifMYA0uJ`$R- zHW_Wo9bpPE&L-%KY(zBA!MU>3b<|^j&3Zs(Hz&SRYG<;ZgxpZ!$j~iL2k9i3&OI%d zTBRL!G7LpV(&>yGpSzO$g6xefE-t>0dPvMv_~pL(dcuy|K_((C9^vw{~zyxtqaZ&NeJ;ek4 zX`AbAHHUmRzA2fry1arf)2|&_xRU;?0sZ@ph=1Q)GI0Ndt|W@?iB!!z-q|j93aq6D zkw)??koveY^O`#e7~;RF$EoP*5kmwgp!-MKZ|vH&OEw=DYBp~`r?kn%lx3wW@xph| zn^#}{3SGtb=~hi;m{Cp)BQxf&DIKL+f*;}a7&*J+#;6%R`iiRNkF_X)x>cd$*|)96 z>zO+F=7nu$xT?0wIUmaz?8+yyCwYnjdiB|A#WpK)T4(i9krNq}CTdo|#>SMZILDv} zcXr3(Cmw51Q{EpsAnaF!-KJRym-m4eY1RYc$_C&lD56CY|4`(&;yoEXL06g|p!Z31 zo+^IUvS$W^!N;6{JOJI&;nz?WIlfw_#cAjfBb?JvI=aXR%C(Glq*dyHnhBAgY0iVW z4WWyOyil_Vu##PBn1OoDrh$o^k`hDw%5E##FS2ObF-BWmeduZ?#6-i#L8Y*(v|dWS zKTbx>u#xL*D;0^hgde_QvS)pl0LCGU`xR8O9LqRHh)m7_|Aj1WoN_*REMc!}K1iJP z@MDEf1z~Rxb~N96j$Zgqrpg16%gD7q@qCvVK9KwBYIJ5=mVAbD2;tjfv6x&N%5j=6 zh%4Ag9-hHXbdppME+gMor~$uh;IbYI?Oh{8bxl>+_ff>W`T?_9M z%c>e9Y)a}#y+#Lh3Fu3_tk$A5U<|VJT>(v^0p+l|2KP=X-m!7QUxz;)-dPL5cXU|2 zg!t!aw%b6TiE)V${+%>a+e5;e7y-Y}`tUX4Jxsi69pnM=qU61njm00)lh+%Yv`qCD zSgQHHy67s*z}|U?OQXq|-|5f};c2A1ajvD&T7_t^S#bjt(2!?jGC&PklH?7frO4CM zczvJN12*$T&bc9F@g0;jo@X(@kA540K4m^SW9@ZY)lxXiV<~q`{M&iUp67vL8oF68K*o9 zoqZ+1TgfK6`zGqsjhZ^_ns>- z!dW!N^_tBYVsyZh2S1=&&RE45K5->Zn(~q?^(kj*x4RM-7~$>I$CaAx5s=1B zY&e{9^_CH)8cANz+Tw5A9YI;L(2(Ej5_`o3_^Gh{RJ7uUP@fN|}>$mKOoucAkcuuHpR z(0F3_DJn*e6Y_$V#$Asx@MU}d*y~^X`TIIIk#3J|IC4dw8VPGn z!)6M+gbGUh2&Oxjd7jbCus4;-F59b>UIRw(GDdI`l3s#p`?1`F7(e5>J(|B}7W%$pU%Zeq+ z2z6@xqIx`}y%~ zC^eeSmzOz=T0cQ@z8lab$cyTapcgTK6;OwNHjOmpRZ)laodZZ#$Bpnw7jD4>7>3iv9+F#Zn