diff --git a/README.md b/README.md index 888dfc7..d3d0e1f 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,13 @@ Your machine must have the following: 1. VS Code Extension: Python 1. Git (configured) +Remember: + - **Spacing, Spelling, Capitalization**: With computers, these are critical. Always double-check! --- -## Verify and Update Default Python +## Verify Installations / Update Default Python In VS Code, open a terminal window (View / Terminal). If macOS/Linux, change `python` to `python3` in the commands below. @@ -29,18 +31,32 @@ python --version python -m pip install --upgrade pip wheel ``` ---- +## Execute Utility Script (Diagnostics) -## Execute Project Scripts +With your repo folder open in VS Code: -With your repo folder open in VS Code, start exploring. - -1. Open acquainted.py (or another .py file). +1. Click util_about.py. 1. If VS Code prompts, install the recommended Python extension. 1. Check the Python Interpreter: On the bottom-left status bar, you might see a version of Python indicated (e.g., Python 3.10.x). 1. If not, click on the bottom status bar where it should show the Python version or might say "Select Python Interpreter". 1. From the dropdown, choose your default Python version. -1. Open a terminal via View / Terminal. +1. In VS Code, open a terminal window (View / Terminal). +1. If macOS/Linux, change `python` to `python3` below. + +```shell +python util_about.py +``` +--- + +## Explore & Execute Project Scripts + +With your repo folder open in VS Code, start exploring. +Open, read, and run each project script (each file will have a .py extension) in order. +You don't need to fully understand the code yet. +Instead, try to figure out what each file is doing. + +1. Open acquainted.py (or another .py file). +1. Read the comments and code carefully. 1. Execute each script - one at a time. 1. On macOS/Linux, change `python` to `python3` in the commands below. @@ -88,15 +104,33 @@ Customize these project scripts. If things still work - sync the code back up to GitHub where it's safe. -1. Use VS Code's "Source Control" icon (on the left). -1. Add a commit message, e.g., "TODO 1". -1. Choose "Commit and Push" to sync to GitHub. +1. On the VS Code side panel, click the source control icon (look for a blue bubble with an number in it). +1. Hint: Mouse over the icons to see their names. +1. Important! Above the Commit button, it will say "Message". +1. You MUST include a commit message. +1. In the commit message input box, type "first TODO". +1. Click the down arrow on the blue "Commit" button to "Commit and Push" to your GitHub repo. + +Verify: Open a browser to your GitHub repo and verify the files have appeared. +In addition to the original files, you should have one or more new files. +If not, return to VS Code and edit/execute files as needed. +Then commit and push again. + +Common Issue: If your computer hangs because you forgot the commit message, +just enter your message in the top line of the file it shows in the editor. +Then click the checkmark in the upper right to close that file and save your commit message. +"Sync your changes" to push to GitHub. --- ## Update README.md -Enhance this README.md as you progress. It uses Markdown, a simple and easy markup language. +Edit this README.md file as you progress. It uses Markdown, a simple and easy markup language. + +- Keep the prerequisites and task headings. +- Within the task headings, keep only the commands that worked on YOUR machine. +- Remove unnecessary instructions once you've mastered them. +- Add any additional notes that will help you in the future. ---