From 4df60e714ceaf3242981d504defefc1701ec3a8d Mon Sep 17 00:00:00 2001
From: Katie Geerling <72274725+punnypenguins@users.noreply.github.com>
Date: Wed, 17 Nov 2021 20:13:07 -0600
Subject: [PATCH 01/12] Adding templates
Edited `card-template.md`, added new content, and created `board-template.md`.
---
board-template.md | 28 ++++++++++++++++++++++++++++
card-template.md | 35 ++++++++++++++++++++++++-----------
2 files changed, 52 insertions(+), 11 deletions(-)
create mode 100644 board-template.md
diff --git a/board-template.md b/board-template.md
new file mode 100644
index 000000000..ad23770df
--- /dev/null
+++ b/board-template.md
@@ -0,0 +1,28 @@
+---
+layout: board
+title: "Name of Board Here"
+short_description: Insert a single sentence summary of the board here.
+status: Here
+picture: "/images/board-(and-then-insert-name-here-without-parentheses).jpg"
+github_issue: "https://github.com/geerlingguy/raspberry-pi-pcie-devices/issues/ID-here"
+link: https://amzn.to/product-link-here
+videos: []
+---
+### Create a new file in the `_boards_cm` directory.
+
+1. Title it with the board name in all-lowercase, using dashes to separate words.
+2. Save it as Markdown file (.md extension).
+3. Paste the contents of this template into the new file.
+4. Replace all the values in its top section with the proper information:
+ - `layout`: Should be left alone! Don't change this.
+ - `title`: Replace *Name of Board Here* with the full name of the board.
+ - `short_description`:
+ - `status`: Can be one of these:
+ * prototype
+ * production
+ - `picture`: Can have a path to a picture like `/images/[type]-card.jpg`, or `false`. Make sure you remember to drop the image into the `images` folder before you submit your pull request!
+ - `github_issue`: Should link to the GitHub issue corresponding to this card.
+ - `link`: should link to the Amazon product page for this card. If no Amazon listing is available, you can substitute a different website instead.
+ - `videos`: Is a list of YouTube video URLs. If there is a video to add, delete the `[]`, hit return, tab in once, add a dash, press the spacebar, and then paste the video url.
+
+Finally, replace all content below the second `---` line with a description of the board, save your changes, and submit the finished entry via pull request.
diff --git a/card-template.md b/card-template.md
index 2ac3809df..5ed3caf88 100644
--- a/card-template.md
+++ b/card-template.md
@@ -1,20 +1,33 @@
---
layout: card
title: "Name of Card Here"
-picture: "/images/name-of-image-here.jpg"
-functionality: "Currently Testing"
-driver_required: "Yes"
+picture: "/images/[card type]-(and-then-insert-name-here-without-parentheses).jpg"
+functionality: "Functionality goes here"
+driver_required: "Answer goes here"
github_issue: "https://github.com/geerlingguy/raspberry-pi-pcie-devices/issues/ID-here"
buy_link: https://amzn.to/product-link-here
videos: []
---
-Copy this template into the appropriate `_cards_[type]` directory, and replace all the values above with the proper information:
+### Create a new file in the appropriate `_cards_[type]` directory.
- - `picture`: can have a path to a picture like `/images/[type]-card.jpg`, or `false`
- - `functionality`: can be one of "Currently Testing", "Full", "Partial", or "None"
- - `driver_required`: can be one of "Yes", "Maybe", or "No"
- - `github_issue`: should link to the GitHub issue corresponding to this card.
- - `buy_link`: should link to the Amazon product page for this card.
- - `videos`: is a list of YouTube video URLs.
+1. Title it with the card name in all-lowercase, using dashes to separate words.
+2. Save it as Markdown file (.md extension).
+3. Paste the contents of this template into the new file.
+4. Replace all the values in its top section with the proper information:
+ - `layout`: Should be left alone! Don't change this.
+ - `title`: Replace *Name of Card Here* with the full name of the board.
+ - `picture`: Can have a path to a picture like `/images/[card type]-card-name.jpg`, or `false`. Make sure you remember to drop the image into the `images` folder before you submit your pull request!
+ - `functionality`: Can be one of the following:
+ * "Currently Testing"
+ * "Full"
+ * "Partial"
+ * "None"
+ - `driver_required`: Can be one of the following:
+ * "Yes"
+ * "Maybe"
+ * "No"
+ - `github_issue`: Should link to the GitHub issue corresponding to this card.
+ - `buy_link`: Should link to the Amazon product page for this card. If no Amazon listing is available, you can substitute a different website instead.
+ - `videos`: Is a list of YouTube video URLs. If there is a video to add, delete the `[]`, hit return, tab in once, add a dash, press the spacebar, and then paste the video url.
-Then replace the text in this area with a description of the card.
+Finally, replace all content below the second `---` line with a description of the card, save your changes, and submit the finished entry via pull request.
From b1730956b3d39c850e221b2d7d518ed8732b6113 Mon Sep 17 00:00:00 2001
From: Katie Geerling <72274725+punnypenguins@users.noreply.github.com>
Date: Fri, 19 Nov 2021 00:20:39 -0600
Subject: [PATCH 02/12] Adding documentation
1. Edited card template
2. Edited board template
3. Removed CONTRIBUTING.md
4. Added an image to the `images` folder
5. Wrote and added a new README.md
---
CONTRIBUTING.md | 23 --------
README.md | 105 +++++++++++++++++++++++++++++++++---
board-template.md | 2 +
card-template.md | 2 +
images/rpi-pcie-devices.png | Bin 0 -> 57648 bytes
5 files changed, 103 insertions(+), 29 deletions(-)
delete mode 100644 CONTRIBUTING.md
create mode 100644 images/rpi-pcie-devices.png
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 9db07700b..000000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Contributing to the Raspberry Pi PCIe Database
-
-Testers welcome!
-
-There are many ways to contribute:
-
- 1. I accept cards mailed to me, and may be able to pay shipping. I can't promise to test the card in a timely fashion, but I will try to, and I will credit you in any videos/posts that result from card testing!
- 2. If you find any typos, incorrect links or images, or other issues, please submit a PR to fix it!
- 3. If you want to test a card on your own, I'm happy to add it to the database, provided you give all the testing details, information like `lspci` and `dmesg` logs, etc. in a GitHub issue, and follow the project's conventions for card details.
-
-## Adding a Card
-
-Add a file named after the card into the appropriate `_cards_[type]` directory. Copy the template out of [`card-template.md`](card-template.md) into this new file.
-
-Add a picture of the card into the `images/` directory, prefixed by `[type]-`, and make sure to reference the full path to the image in the `picture` frontmatter on the card post.
-
-For example, for a network card:
-
- 1. Make sure there's a GitHub issue that exists for the card.
- 2. Copy the template into a new file inside `_cards_network`.
- 3. Fill in the details of the card.
- 4. Put a picture of the card named `network-[name-of-card].jpg` inside `images/`.
- 5. File a PR with your changes.
diff --git a/README.md b/README.md
index 1b78edad7..63962f831 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,104 @@
-# Raspberry Pi PCI Express device compatibility database
+# Raspberry Pi PCIe Devices
-This repository builds the GitHub pages site: [http://pipci.jeffgeerling.com](http://pipci.jeffgeerling.com)
+
+
+
+
+[](https://github.com/sponsors/geerlingguy#sponsors)
+
-If you would like to add a new device to the site, or correct the information about an existing device, please file a Pull Request against this repository.
+[**Raspberry Pi PCIe Devices**](https://pipci.jeffgeerling.com/) is a compatibility database tracking which devices are and are not compatible with the [Raspberry Pi CM4](https://www.raspberrypi.com/products/compute-module-4/).
-## Local Editing
+
+ 
+
-This site uses Jekyll to build and serve pages. On a local workstation, clone the repository, make sure you have Ruby, Bundler, and Jekyll installed, then run `jekyll serve`.
+
+ 
+
-Access the local site at the address Jekyll provides.
+## 🔧 Setup and installation
+
+To run a copy of this website in a local web development environment, you need to have **Jekyll**, **GitHub CLI** *OR* **GitHub Desktop**, and a local clone of the website's repository.
+
+### Jekyll
+This site is built using [Jekyll](https://jekyllrb.com/), a [Ruby](https://www.ruby-lang.org/en/) gem.
+
+**To install Jekyll:**
+1. Visit Jekyll's [installation page](https://jekyllrb.com/docs/installation/) in your browser
+2. Click the guide for your operating system (macOS, Ubuntu, Other Linux, or Windows)
+3. Follow the step-by-step instructions to install Jekyll.
+
+### GitHub
+There are two ways to use GitHub locally:
+* via [GitHub CLI](https://cli.github.com/), using the command line
+* via [GitHub Desktop](https://desktop.github.com/), an app available for macOS and Windows
+
+## 🧰 Development
+
+Once you have Jekyll running and the [raspberry-pi-pcie-devices repository](https://github.com/geerlingguy/raspberry-pi-pcie-devices) cloned, you can build and run the site locally.
+
+### Build the site locally
+1. In the command line, `cd` into the `raspberry-pi-pcie-devices` folder that contains the cloned repository.
+2. To build the site, run `jekyll serve`.
+3. You should now be able to access the local site at http://localhost:4000 in your web browser of choice.
+
+As long as `jekyll serve` is running, you'll be able to watch the site and all changes you make to it in real time.
+
+## 🧑💻 Contributing
+
+### Ways to contribute
+* **Add a card or board to the list:** Use issues and pull requests to add new board entries and card entries to the site.
+* **Test a card yourself:** If you want to test a card on your own, I'm happy to add it to the database, provided you give all the testing details, information like `lspci` and `dmesg` logs, etc. in a GitHub issue, and follow the project's conventions for card details.
+* **Fix problems with the repository:** If you find any typos, incorrect links or images, or other issues in this repository, please submit a pull request to fix the problem or [open a new issue](https://github.com/geerlingguy/raspberry-pi-pcie-devices/issues/new/choose) to point the problem out for someone else to fix.
+* **Mail me a card or board:** I accept cards and boards mailed to me, and can occasionally pay shipping as well. I credit senders in all videos/posts that result from donated card testing!
+
+### General instructions for contributing
+
+To contribute to **Raspberry Pi PCIe Devices**, follow these steps:
+1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository.
+2. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) that new repository to your device.
+3. Create a [new branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches#creating-a-branch).
+3. (Optional) use `jekyll serve` to build the site in your local development environment while you're working on it.
+4. Once you're satisfied with your changes, [commit them](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project).
+5. [Push](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github) the changes to the correct branch.
+6. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+7. Give yourself a high five, you did a great job. Thanks for contributing!
+
+### Add a card
+Add a new file named after the card in the appropriate `_cards_[type]` directory.
+Copy the template out of [`card-template.md`](card-template.md) into this new file and follow the instructions it contains.
+
+#### Specific example: Adding a network card
+To add a network card to the database:
+1. Make sure a GitHub [issue](https://github.com/geerlingguy/raspberry-pi-pcie-devices/issues) exists for the card. Open a new issue for it you find that there isn't one.
+2. Copy the template into a new Markdown file you create inside `_cards_network`.
+3. Fill in the card information as described in [`card-template.md`](card-template.md).
+4. Place a picture of the card named network-[name-of-card-here-minus-brackets].jpg inside the `images/` folder.
+5. Submit a pull request with your changes.
+
+### Add a board
+Add a new file named after the card in the appropriate `_boards_cm` directory.
+Copy the template out of [`board-template.md`](board-template.md) into this new file and follow the instructions it contains.
+
+## 🤝 Support
+Drop a ⭐ if this project helped you!
+
+
+
+## ✍️ Authors
+### Jeff Geerling
+* Creator and maintainer
+* [@geerlingguy](/) on GitHub
+* [](https://www.youtube.com/c/JeffGeerling)
+
+### Katie Geerling
+* Documentation writer
+* Occasional contributor
+* [@punnypenguins] on GitHub
+
+## 📝 License
+
+This project is maintained by [Jeff Geerling](https://www.jeffgeerling.com/). The Raspberry Pi Compute Module 4 is a product of [Raspberry Pi (Trading) Limited](https://www.raspberrypi.org/about/).
+
+This project uses the [GNU General Public License, version 3](https://opensource.org/licenses/GPL-3.0).
diff --git a/board-template.md b/board-template.md
index ad23770df..785a2bca6 100644
--- a/board-template.md
+++ b/board-template.md
@@ -8,6 +8,8 @@ github_issue: "https://github.com/geerlingguy/raspberry-pi-pcie-devices/issues/I
link: https://amzn.to/product-link-here
videos: []
---
+# INSTRUCTIONS:
+
### Create a new file in the `_boards_cm` directory.
1. Title it with the board name in all-lowercase, using dashes to separate words.
diff --git a/card-template.md b/card-template.md
index 5ed3caf88..eafe672ae 100644
--- a/card-template.md
+++ b/card-template.md
@@ -8,6 +8,8 @@ github_issue: "https://github.com/geerlingguy/raspberry-pi-pcie-devices/issues/I
buy_link: https://amzn.to/product-link-here
videos: []
---
+# INSTRUCTIONS:
+
### Create a new file in the appropriate `_cards_[type]` directory.
1. Title it with the card name in all-lowercase, using dashes to separate words.
diff --git a/images/rpi-pcie-devices.png b/images/rpi-pcie-devices.png
new file mode 100644
index 0000000000000000000000000000000000000000..7631c8a997ec595445676b8f21ab7d80ea779eca
GIT binary patch
literal 57648
zcmeFYWmr^Q-!}|MiYS6~x02E_lr%^;LkviVfb`Hxh=6o=cf$bEq9P>?LrF;YP(#PF
z@x1QqI^X9$-}m|O9LM|V<~TO9X79E3+WYtKm{2tpIlTMi_fb$#@D${wHBeB{TTxI@
zRj@IEGoRYfqfk&DnAu24sVPWF(W*H+TH3s^KtYiYO-RDh)9fXFx1Oj)pihgYA?cXw
ziYAYfBZD8!`tg-K8V=LdMQ$)3wXB!7N^@!E_fM7sLY;P=-$m`=bdAT4VjEQBl~hm6epuVw&F()1rv#wVk5{
zeq9CuM0z;9*#Vb>Z#Po
zk-q;f5_RR}`(&=5bZk#8Kfm{3>r(FTE_ix`>FRhps#C57FH^pqoL}v{*6HTg>&YPq
zW{(m-x>Xvu(MjIgYaf5n3!2ZTV$)~ey*
zQK*PYz5m28S^P`T4(m#Ytb{-?CFekRD7=Taj`6oh&)fQJUdG^7>47O3dKtZdA8THo
z515;k@K5rojerY^{p?Nj_M(j&?)4+cfrT0o0D0##Rv1YV(QUYo#%+e)p
z&&y1?1uf;}DnIF-JKjs-h?Na0-Zk3f^*&WPgohlexI3_esVGV
z*v(ev5k|=*%UCp3J
z=>AYRf9W^>@!Pj}cmu@Z8>*ZzhVyP8pMmsJC04_2!xkfP+l!Yu*0MRaflj#QysNQq
zoan;ub)eA`tFn@chOO>x?P0##O3U?AZZm!8$A-U_(qWEKgtD)_TUOd(PS%ZL4Ml%P
zz0H+E<%6}Mf%2jp|LLlXEm@@({^IOQti7jZCJ)Qs-}}@<1-<8w|KRJF7x=gY60FH+
zN9-TA!4C@qr%h0wVyv17>D?>+!dy+XgDxJ>mi?F#U9J=7EwLer?iY^Fe$8KahjHiM
z`Jqe5V^h7R{qYgQH2ej_9ySGz^w(%>Mrs8ap6EByVNYYGdj#c$Y6(gt8))l$hI&v}
zo;s6nzI32HjdoaJIz;VKBe#8*n&ZAf8Xw_2{FLu;#wW|Xv0+nJy5=Vp(ssjh*7v-g
zh=xNXgh#BbX)vF2dZ>hWF`alOvadvrq0vh*N5
zxaA8!Whl#UG#_#?65{~f-@*r&t#}h3G7|JAuPEK8?TS6im(+M>
zLuDhliM>f*5`G+6F4I8U68Ejw#{5}RkfFr9jF?ipyr0ru(T2vGXMXW|VbMHswV!Gu
zMwNtAH*=3Qk;NzDD7N(cA#7acW-8I-Oj)jcu7b(Ys1d~If(pJ#LekLOC++_!A%LrntuQ+BYlnF@nnKnk-|`
zF>s-Q@=(f2N=lkca_>)g3Kj1*w^b@u+In)8fcTqv`_5`?ShQYw!wb`cc#EE;>O;MR
zasi#Hf)b1Tf>Gyiix!KHgf{J1?a&G8GGVxuU4vU9(so;C8$yAbb|6q^zxBppM&r$N
zgXwI21B?B_%=B!*l&{sK_38Kdo=hv_H^x@}v+wutSDp{#{P92>+weHNJL&%R1I02
zfMr*5oS9gQSJPUPgG<|LAwpoV;(NvPZb3_2%a^v9>sqWihF@lxa&g_bs#dBo>#{@J
zkOx%W`TyqKG+x6Nz`)DB>oHFRf_Vo-@34F|mraz!xuO-ten-t9}mk-ZzV6
zUZKM412J=>OjehiRJ63c|Y`dAv)OtbrhBg%m~Dw0OfZ{lp0yMcQ&`G+2U
zf4C8mH_M=ygZ{57!jFVY%v!3@CkSG3;Tv-_hS#=VD}w|>=|cMn9GQd|pT+6Nxy6pf
z*~Kjs1{IboZKl7lTuKkM(p1)9Dp9t{hpoVNZG7XtGFPOGC+sCaQvKX&uUE+8R8_fC
zVg*-+wK7VsN-lY@$)1t5@Q59no%3I{D?!#SenL=nt9AC3NZAcJc8D=P>V#2SVVGC^
z^opg5ZewjRpk%DXKb8L+%i0^B-jl8@Zmu1~*g(iAS(WSs1V-17%
zKFEBqRs+1w*I{E^o%NgffYf7L99*EmX;~vyYQfmY?N%>
z5;R~aa^&O$J$O{N4-NoV)NxpGCHp!)v>Hro>iPAvsp6=7og;mcU)=O&5Mvyp3D=L!
zi31Eiyhw|8OeIO>NblJ1Y<#=`Pq0nuQ>^k`znv?TIiv5*J?WwjpX9hPWM&uE+|!4s
z-#CSu^rj%@+N-YoOl;tzCl>Sl0-P+INt_+c^wwR230`dBx?+0#e%jw`;ajy6Rg+3a
zF3n%-Ovm)M^jBvF`!@Ot-2}E1t1k7JDw{Q^G}^4%HZQui7aZ^%K7Zzhnq4#3DX*r9
zy-9r2-p*vIC>3F(+@-Sw&#j1RU~&{bzjqljv&%f&-{?O>H#gG6>t|(9p=!U&IcC(q
zH4L&aI^8>-Bk_B1T~jh&;MY&RmU)=8D+%o!){jCaJJE9_i5Vh`@H9Blo|4yC)YGbzI-0?-glD
z<2wwhN5X4DyEz+`t?k6A-LA$%_X)dIoK>iWh~923+H{Oz4OS2FWg^99-wtm7x>;!T
zn_bwOn}0jM?lXq5fIC2CCj8L&K{NDNW21mD$unsP652HC#J{gNx!a-9_U>w-L{-r4UibA*#&VL#zF)buX3^_qON`QfSjk!a*5T
zm8fy!Nf&a?H}1CZ)_z)e*+Y1tZXxR``tY~Y?Qv9oR6-V|IKO}7g^xF_zsbuVNk>>w
zXr$%VI>abk9w;wWG2S_$LI{~l5I%tz>I<4!I9Dt>3%FR}f+z+CDDvr#UMf9DNz=B%
z?*T!$TpOq4tQVI&dBuz7C3kwGqYe&}yJhMO$go5){9_)gG
zLdwcv!>zXfKapol<0z|h{p^))Tj{*8kR
z2r5edX9fru-<{^7r~Na<)lQUNPg#vt%F)?^mYOI6Zhd9i6SXxP^p-xSsQH@$hf}GdNs49b8{SIUHOV{<_J3-ACHO
z#mw2}t*ecr1MS^?Uz<9*xr)-$-);2ozrUW-0&4T0og7^L^;*CSa@}3w;^utL_3wKF
zOGWO^g4ArF7H{;VZR`QefIY;xdANB*{w(-!m;STmUrV)JES#kr?SYl9V*f$?UyJ{K
z@qb_VXHW2d_T=T|`}>xEyYjDN8!uiix0BEuMB3%C_n%Mm(JGyr1aTZh8Xhe!9P#PpnJDCky4sZ`_Gr@-z|3e{(Z;)Jjd`eG;BylsmlF(
z|2g-!nZQEPzkU7N@P8K4{(pkAyq4vE(