Skip to content

Commit

Permalink
add basic usage
Browse files Browse the repository at this point in the history
  • Loading branch information
St0n14 committed Aug 21, 2024
1 parent adc545b commit 5d4cb8f
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# How-to Guide for pyDFIRRam

## Introduction

Welcome to the How-to Guide for pyDFIRRam, a Python wrapper for the Volatility framework. This guide will help you get started with the package, configure it, and perform common tasks.

## Table of Contents

1. [Getting Started](#getting-started)
2. [Configuration](#configuration)
3. [Basic Usage](#basic-usage)
4. [Advanced Usage](#advanced-usage)
5. [Troubleshooting](#troubleshooting)
6. [Additional Resources](#additional-resources)

## Getting Started
### Prerequisite
- Python3.10
### Installation

To install pyDFIRRam, use pip:
```bash
pip install pydfirram
```

### Basic Usage
```python
from pydfirram.modules.windows import Windws
wrap = Windows("dmp.raw")

data = wrap.<plugins>().<rendering>()
```

0 comments on commit 5d4cb8f

Please sign in to comment.