Skip to content
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

✨ Update README.md with detailed instructions and improved clarity #17

Merged
merged 7 commits into from
Jun 3, 2024

Conversation

aliphys
Copy link
Member

@aliphys aliphys commented May 14, 2024

Closes #16.

The Instructions section of the README.md file for the Arduino Cellular library has been updated to provide clearer and more detailed setup instructions, with improved visuals, including:

  • 📐 SIM card form factor: Specifically state SIM card size (nano)
  • 👆 SIM slot location: Made clear that the nano SIM card is inserted into the Portenta Mid Carrier. A photograph from above is also provided that better shows the size and location
  • 🛠️ Fixing PRO 4G Module: Added step explaining how to physically fix the PRO 4G Module to prevent damage
  • 📻 Antenna Connections: Explicitly mentioned which antenna should be connected to which microUFL connector for both the cellular and GNSS antenna. Reference is made to the Arduino Pro 4G Module Antennas Kit since the antenna is NOT included by default with the PRO 4G GNSS/EMEA modules
  • 🔌 Power supply: Use of external power supply (not USB) is mentioned, based on approach borrowed from @marqdevx

Thanks to @marqdevx and @i-herrera for their feedback, and @kengdahl for taking the images.

@jcarolinares these instructions could be useful for content development

@aliphys aliphys added the topic: documentation Related to documentation for the project label May 14, 2024
@aliphys aliphys self-assigned this May 14, 2024
@sebromero
Copy link
Contributor

@aliphys Please convert the PNGs to JPG 🙏

Copy link
Contributor

@sebromero sebromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aliphys Thanks for the PR! Please convert the images to JPG and move them to ./docs/assets.

@aliphys
Copy link
Member Author

aliphys commented May 23, 2024

@aliphys aliphys merged commit e973e01 into arduino-libraries:main Jun 3, 2024
3 checks passed
@aliphys aliphys deleted the readmeInstructions branch June 3, 2024 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Instructions in README.md require clarification
2 participants