Skip to content

CodeCompasss/code_campus_userguide

Repository files navigation

🚀 CodeCampus OS — Official User Guide

License: Personal Use Only Build Status Stars

Bridge the gap between academic theory and real-world software engineering.

CodeCampus OS is a custom Linux distribution designed specifically for Computer Science students and beginner developers. This repository contains the Official User Guide, a comprehensive, student-focused resource that documents the professional tools, workflows, and environments pre-configured in CodeCampus OS.


🌟 Why This Repo?

Setting up a development environment often takes months for students to get right. CodeCampus OS removes that barrier, and this guide teaches you how to master the tools like a Pro.

  • 🎯 Student-Focused: Every explanation is written for beginners but never "dumbed down."
  • 🧠 Professional Insight: Learn the "Top 1%" tricks used by senior engineers.
  • 🛠️ Actionable Workflows: Concrete examples for everything from Git and Docker to Neovim and SQL.
  • 🐧 Linux Agnostic: While optimized for CodeCampus OS, our installation guides cover Ubuntu, Arch, Fedora, and openSUSE.

🗺️ Roadmap & Sections

  • Getting Started: Philosophy, Hotkeys, and Tiling window management.
  • Terminal Mastery: Deep dives into Zsh, CLI utilities (fd, ripgrep, fzf), and terminal UIs.
  • Development Stack: Mastering VS Code, Neovim, and Spyder with professional configuration.
  • System Utilities: Extension management, power efficiency, and remote access.

🛠️ Local Development

This guide is built using MkDocs Material.

Prerequisites

  • Python 3.x
  • pip

Setup

  1. Clone the repository:
    git clone https://github.com/CodeCompasss/code_campus_userguide.git
    cd code_campus_userguide
  2. Install dependencies:
    pip install -r requirements.txt
  3. Run the live preview:
    mkdocs serve
    Open http://127.0.0.1:8000 in your browser.

##🤝 Contributing

We love contributions! Whether it's fixing a typo, adding a new tool guide, or improving an explanation, please check out our Contributing Guide.


⭐ Support Us

If you find this guide helpful, please give us a star on GitHub! It helps more students find this resource and stay motivated in their coding journey.


📄 License

Distributed under the CodeCompass Personal Use License. Strictly for individual learning only. Institutional and commercial use requires a separate license. See LICENSE for more information.


Built with ❤️ by the CodeCompass Team.