Skip to content

Getting Started Page #848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 29 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
8ce7a8b
initial getting started
jwcooper Jan 20, 2022
bdfadc7
styling of tab block content
jwcooper Jan 20, 2022
3f85abb
split out sections and add js for content
jwcooper Jan 20, 2022
2484aa7
clean up css and js and add more includes
jwcooper Jan 20, 2022
d9e126f
clean up mobile layout
jwcooper Jan 20, 2022
8ed2750
revert back to old get started link until content is filled in
jwcooper Jan 21, 2022
270bbfe
Initial content updates.
kattni Feb 3, 2022
c9323d0
Update _connecting, fill out _libraries.
kattni Feb 3, 2022
f422453
Current content for _installation
kattni Feb 4, 2022
99fbce1
Update esp32s3 devkits
prplz Jan 15, 2022
c2adfac
Add Waveshare RP2040-Zero board
CharString Jan 21, 2022
c1de7fa
Update adafruit_feather_rp2040.md
sctv Jan 24, 2022
d3c7898
Update adafruit_feather_rp2040.md
sctv Jan 25, 2022
7306da0
Update raspberry_pi_pico.md
sctv Jan 26, 2022
4fa644f
Add missing space
fabaff Jan 29, 2022
7abcdf6
Remove content
fabaff Jan 29, 2022
60b4f8c
Format as code
fabaff Jan 29, 2022
dd9bea5
Add link to shop
fabaff Jan 30, 2022
35b1810
Added my new TinyS3, FeatherS3 and ProS3
UnexpectedMaker Jan 29, 2022
d250065
Remove title
fabaff Jan 30, 2022
f055669
Add tutorial section
fabaff Jan 30, 2022
74bbf70
Add link to switching the bootloader instructions
fabaff Jan 30, 2022
f23cc56
Switch to unordered lists
fabaff Feb 1, 2022
2247cad
Content updates.
kattni Feb 4, 2022
c794239
Merge branch 'main' into getting-started
jwcooper Feb 11, 2022
aed6f17
fix ol sizing on start
jwcooper Feb 11, 2022
4ed9f7e
Merge branch 'main' into getting-started
makermelissa Feb 14, 2023
2b510a5
default to ruby 3.1.3
jwcooper Feb 14, 2023
683b7cf
update getting started links to new start page
jwcooper Feb 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update _connecting, fill out _libraries.
  • Loading branch information
kattni committed Feb 3, 2022
commit c9323d05924aa8931f729ffcf099ac48400eb89c
49 changes: 36 additions & 13 deletions start/_connecting.html
Original file line number Diff line number Diff line change
@@ -15,13 +15,30 @@ <h3>Connecting</h3>
<h4>USB Cable</h4>
<p>
Many CircuitPython-compatible boards use USB for connecting to your computer and
powering the board. Check your board to see what type of USB cable you need
(USB Type C or USB Micro). Verify that you're using a USB cable capable of data
sync and not a charge-only cable - this is a common mistake that can lead to
frustration! Plug the USB cable into your board, and plug the opposite end into
your computer. After a moment, you should see the CIRCUITPY drive. Remember, if you
haven't installed CircuitPython, you will not see a CIRCUITPY drive. That's all
there is to using a USB cable to connect your computer to your CircuitPython board!
powering the board. Follow these steps to get your board connected.
</p>
<ol>
<li>
Check your board to see what type of USB cable you need
(USB Type C or USB Micro).
</li>
<li>
Verify that you're using a USB cable capable of data
sync and not a charge-only cable - this is a common mistake that can lead to
frustration!
</li>
<li>
Plug the USB cable into your board, and plug the opposite end into
your computer. After a moment, you should see the CIRCUITPY drive.
</li>
</ol>
<p>
Remember, if you haven't installed CircuitPython, you will not see a CIRCUITPY
drive.
</p>
<p>
That's all there is to using a USB cable to connect your computer to your
CircuitPython board!
</p>
</div>
</div> <!-- end tab-content -->
@@ -33,10 +50,12 @@ <h4>PyLeap iOS App</h4>
PyLeap is an iOS app by Adafruit designed to quickly get you started by loading
existing projects onto your device. These projects are available from
<a href="https://learn.adafruit.com">learn.adafruit.com</a>.

</p>
<p>
<a href="https://adafru.it/pyleap">Get PyLeap</a> through Apple's beta testing app,
TestFlight.

</p>
<p>
PyLeap is openly developed
<a href="https://github.com/adafruit/PyLeap-iOS">on GitHub</a>.
</p>
@@ -51,10 +70,12 @@ <h4>File Glider iOS App</h4>
Files can be edited directly in File Glider or indirectly in other Files API
compatible apps. The app is not CircuitPython specific so it can be used with any
file transfer capable device.

</p>
<p>
<a href="https://adafru.it/file-glider">Get File Glider</a> through Apple's beta
testing app, TestFlight.

</p>
<p>
File Glider is openly developed
<a href="https://github.com/adafruit/Glider-for-iOS">on GitHub</a>.
</p>
@@ -68,10 +89,12 @@ <h4>code.circuitpython.org</h4>
<a href="https://code.circuitpython.org">code.circuitpython.org</a> is a webapp
designed by Adafruit to edit files over WebBluetooth in Chrome. This works on the
latest Chrome on desktop and on Android.

</p>
<p>
Go to <a href="https://code.circuitpython.org">code.circuitpython.org</a> to get
started.

</p>
<p>
The web editor is openly developed
<a href="https://github.com/circuitpython/web-editor">on GitHub</a>.
</p>
47 changes: 44 additions & 3 deletions start/_libraries.html
Original file line number Diff line number Diff line change
@@ -13,7 +13,25 @@ <h3>Libraries</h3>
<div class="details">
<h4>Download &amp; Installation</h4>
<p>
Download Installation Content Here.
Many CircuitPython programs require you to load external libraries on your CIRCUITPY
drive in the lib/ folder. To do so, you download the libraries in the appropriate
library bundle, and copy the necessary files and folders to CIRCUITPY/lib. You can
also download a Project Bundle for a specific project in the Adafruit Learn System
and copy the files and folders within to your CIRCUITPY drive.
</p>
<p>
Visit the <a href="https://circuitpython.org/libraries">Libraries page</a> to
download the latest bundle. You should download the version that matches the version
of CircuitPython you installed on your board.
</p>
<p>
To learn how to load individual libraries onto your CircuitPython board, visit the
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">CircuitPython Libraries page</a>
in the Welcome to CircuitPython guide.
</p>
<p>
To use a Project Bundle, simply click the "Download Project Bundle" button above
the code in the <a href="https://learn.adafruit.com">Adafruit Learn System</a>.
</p>
</div>
</div> <!-- end tab-content -->
@@ -22,7 +40,17 @@ <h4>Download &amp; Installation</h4>
<div class="details">
<h4>Library Bundles</h4>
<p>
Bundles Content Here.
CircuitPython libraries are made available in library bundles. There are currently
two: the Adafruit CircuitPython Bundle, the Community Bundle. The Adafruit
CircuitPython library bundle is made up of Adafruit-sponsored drivers and helper
libraries. The Community library bundle is made up of libraries submitted by
individual community members.
<!-- Eventually add CircuitPython Org bundle here. "The CircuitPython Org bundle is
made up of libraries collectively maintained by the community." -->
</p>
<p>
Visit the <a href="https://circuitpython.org/libraries">Libraries page</a> to
download the latest bundle.
</p>
</div>
</div> <!-- end tab-content -->
@@ -31,7 +59,20 @@ <h4>Library Bundles</h4>
<div class="details">
<h4>Project Bundles</h4>
<p>
Bundle Fly Content Here.
There are many CircuitPython libraries available. Each CircuitPython program uses a
subset of these. Some use more than others. When a program uses a significant
number of libraries, it can be frustrating to load them all manually. This is where
the Project Bundles come in. The
<a href="https://learn.adafruit.com">Adafruit Learn System</a> has many
CircuitPython projects available. Many of the programs within these projects have a
"Download Project Bundle" button available at the top. This button downloads a zip
file containing a code.py and all the files and libraries you need to use it. We
have made it super simple to get started with a project. Simply download the Project
Bundle, copy everything over to your CIRCUITPY drive, and you're ready to go!
</p>
<p>
Click the "Download Project Bundle" button above the code in any Adafruit Learn
Guide to get started.
</p>
</div>
</div> <!-- end tab-content -->