Published link: https://thebiggest0.github.io/pycharm-github-docs/
Welcome, first-term CST students! As you begin your exciting journey in the world of programming, this guide is here to assist you with the initial setups of PyCharm and GitHub, which are essential tools for your COMP 1510 Procedural Programming course.
These are the topics of this document:
- GitHub Setup
- PyCharm Installation
- Connect PyCharmm to Github
This project was a collaborative effort. Building upon our team's experience from previous projects, we leveraged our understanding of individual strengths and communication styles to work effectively. Development occurred on the main branch, with each team member focusing on their assigned areas while actively communicating via Discord to solve problems and share ideas.
This guide was created based on official user guides from PyCharm and GitHub. We summarized key information and included solutions to common difficulties we faced during PyCharm and GitHub setup, aiming to make the process smoother for others.
This was our first time using Markdown to create content for a website. We built the website using Visual Studio Code (VS Code) as our IDE and employed MkDocs as our static site generator. MkDocs's built-in functionality simplified the process, allowing us to focus on developing quality content rather than website styling.
This project taught us the importance of audience focus. We learned to present technical information by breaking down complex procedures to individual steps.
This documentation is tailored for:
- First-term CST students on macOS.
- Beginner developers embarking on the software development path.
Before starting, you should have:
- Basic computing skills for application management.
- Internet navigation skills for research and operations.
- Email management skills for account handling.
| Requirement | Minimum | Recommended |
|---|---|---|
| RAM | 4 GB free RAM | 8 GB free RAM |
| CPU | Any CPU | Multi-Core CPU |
| Disk Space | 3.5 GB | SSD Drive |
| Operating System | 64 bit macOS 12.0 | Latest 64 bit macOS |
Ensure you have:
- Git: Version control accessible via Terminal.
- Python: Python 3 installed with the correct system path.
- Bold: Indicates buttons or actionable items.
- "Quotations": Denote links or embedded URLs.
- Admonitions: Color-coded notes for different purposes:
- Danger: Security risk warnings.
- Warning: Precautionary instructions.
- Info: Supplementary details.
- Success: Confirmation of successful steps.
By following the steps outlined in this guide, you'll have successfully installed PyCharm and GitHub. Remember, version control and effective collaboration are crucial skills for software development. Feel free to refer back to this guide as needed, and don't hesitate to seek help from instructors or peers if you encounter any challenges. Best of luck in your journey in CST!