No description
Find a file
Limor "Ladyada" Fried 7c931a1c0a
Merge pull request #738 from makermelissa/master
Added 6 missing boards
2021-08-13 12:20:49 -04:00
.github/workflows
_blinka
_board Added 6 missing boards 2021-08-13 09:13:17 -07:00
_data download counts 2021-08-11 22:09:23 -04:00
_includes
_layouts
adabot@f879b24c5f Updated adabot submodule to use main branch 2021-08-05 14:57:30 -04:00
assets Added 6 missing boards 2021-08-13 09:13:17 -07:00
awesome-circuitpython@8ec68729b0
contributing
doc
lib/tasks
libraries
.gitignore
.gitmodules
404.html
_config.yml
awesome.html
blinka.html
CNAME
downloads.html
feed.html
Gemfile
Gemfile.lock Bump addressable from 2.7.0 to 2.8.0 2021-07-13 01:13:06 +00:00
index.html
Rakefile
README.md
stats.html
template.md Add Breadboard-Friendly and Arduino Shield Compatible. Other feature corrections. 2021-07-30 17:32:56 -04:00
trademarks.html

CircuitPython organization site

To add a new board to the site:

  1. Duplicate template.md to _board/<board id>.md.
  2. Edit _board/<board id>.md according to the template's instructions.
  3. Provide 3 images. An original high-quality image. A smaller image (300 px width), and a larger image (700 px width) in each respective directory (assets/images/boards/{small large original}) and process them in something like https://squoosh.app/ to reduce file size. If you only have one image, place it in the 'original' folder.
  4. Create a pull request with the file changes.

To test your changes locally:

  1. You need "ruby" and "ruby-bundler" installed locally. These instructions were tested with ruby 2.5 and ruby-bundler 1.17.3 on a Debian Stretch system.
  2. As needed, git submodule update --init --recursive to fetch the submodules
  3. One time, run bundle config set path 'vendor/bundle' && bundle install
  4. Run bundle exec jekyll serve to generate the site locally
  5. Visit the displayed "server address"
  6. After most local edits, the content will be updated. You will need to reload (ctrl-r or F5) your browser