mirror of
https://github.com/varun-r-mallya/Python-BPF.git
synced 2026-02-07 13:40:59 +00:00
Add comprehensive Sphinx documentation structure and content
Co-authored-by: r41k0u <76248539+r41k0u@users.noreply.github.com>
This commit is contained in:
45
docs/getting-started/index.md
Normal file
45
docs/getting-started/index.md
Normal file
@ -0,0 +1,45 @@
|
||||
# Getting Started
|
||||
|
||||
Welcome to PythonBPF! This section will help you get started with writing eBPF programs in Python.
|
||||
|
||||
## What You'll Learn
|
||||
|
||||
In this section, you'll learn how to:
|
||||
|
||||
1. **Install PythonBPF** - Set up your development environment with all necessary dependencies
|
||||
2. **Write Your First Program** - Create a simple BPF program to understand the basics
|
||||
3. **Understand Core Concepts** - Learn about decorators, compilation, and program structure
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, make sure you have:
|
||||
|
||||
* A Linux system (eBPF requires Linux kernel 4.15+)
|
||||
* Python 3.10 or higher
|
||||
* Root or sudo access (required for loading BPF programs)
|
||||
* Basic understanding of Python programming
|
||||
|
||||
## Quick Navigation
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
installation
|
||||
quickstart
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
After completing the getting started guide, you can:
|
||||
|
||||
* Explore the {doc}`../user-guide/index` for detailed information on features
|
||||
* Check out the {doc}`../api/index` for complete API reference
|
||||
* Browse the [examples directory](https://github.com/pythonbpf/Python-BPF/tree/master/examples) for more complex programs
|
||||
|
||||
## Need Help?
|
||||
|
||||
If you encounter any issues:
|
||||
|
||||
* Check the [GitHub Issues](https://github.com/pythonbpf/Python-BPF/issues) for known problems
|
||||
* Review the [README](https://github.com/pythonbpf/Python-BPF/blob/master/README.md) for additional information
|
||||
* Reach out to the maintainers: [@r41k0u](https://github.com/r41k0u) and [@varun-r-mallya](https://github.com/varun-r-mallya)
|
||||
Reference in New Issue
Block a user