Welcome to the comprehensive documentation for Standalone Python, a portable Python distribution that runs on any Linux system without GLIBC dependencies.

This documentation covers everything you need to know about using, building, and contributing to Standalone Python.

• Installation Guide - Download, extract, and set up Standalone Python
• Usage Guide - Run Python scripts, install packages, and configure your environment
• FAQ - Common questions and quick answers

• Architecture - Deep dive into the system design and implementation
• Technical Reference - Detailed specifications, dependencies, and configurations
• Build Instructions - Build your own Standalone Python from source

• Contributing Guide - How to contribute to the project
• CI/CD Documentation - Understanding the automated build and release pipelines
• Troubleshooting - Solutions to common problems

Throughout this documentation, we use the following conventions:

• code blocks - Commands to run or code examples
• Bold text - Important concepts or warnings
• Italic text - Emphasis or first use of technical terms
• 📝 Note boxes - Additional information or tips
• ⚠️ Warning boxes - Critical information to avoid problems
• ✅ Success indicators - Expected successful outcomes
• ❌ Error indicators - Common error scenarios

End Users

1. Start with INSTALLATION.md
2. Read USAGE.md for daily use
3. Check FAQ.md for common questions
4. Consult TROUBLESHOOTING.md if you encounter issues

System Administrators

1. Review TECHNICAL.md for system requirements
2. Study ARCHITECTURE.md for deployment considerations
3. Check BUILD.md for custom builds
4. Reference CI_CD.md for automation

Developers

1. Understand ARCHITECTURE.md first
2. Set up with CONTRIBUTING.md
3. Build using BUILD.md
4. Review TECHNICAL.md for specifications

Installation & Setup

• System requirements → INSTALLATION.md
• Download locations → INSTALLATION.md
• Verification → INSTALLATION.md

Runtime & Usage

• Environment variables → USAGE.md
• Package management → USAGE.md
• Integration → USAGE.md

Building & Development

• Dependencies → BUILD.md
• Docker builds → BUILD.md
• Testing → CONTRIBUTING.md

Architecture & Design

• Musl libc integration → ARCHITECTURE.md
• ELF patching → ARCHITECTURE.md
• Portability → ARCHITECTURE.md

1. Check the documentation - Most answers are here
2. Search the FAQ - FAQ.md
3. Troubleshooting guide - TROUBLESHOOTING.md
4. GitHub Issues - Report bugs or request features
5. Community - Join discussions on GitHub

This documentation is maintained alongside the codebase. To suggest improvements:

1. Open an issue describing the documentation gap
2. Submit a pull request with your proposed changes
3. Follow the guidelines in CONTRIBUTING.md

• Project Repository
• Release Downloads
• Python Official Documentation
• Musl Libc Project

Last updated: October 2024