fiwi_monitor/SETUP_GIT.md

141 lines
2.9 KiB
Markdown

# Setting Up Git Repository
This guide helps you set up this project in the Umber git repository.
## Option 1: Create New Repository
### On Your Git Server (Gitea/GitHub/etc.)
1. Create a new repository named `wireless-monitor` (or your preferred name)
2. Note the repository URL (e.g., `https://git.umber.com/rjmcmahon/wireless-monitor.git`)
### On Raspberry Pi 5
```bash
cd wireless-monitor-template
# Initialize git (if not already done)
git init
# Add all files
git add -A
# Create initial commit
git commit -m "Initial commit: Linux wireless monitor for ESP32 verification"
# Add remote repository
git remote add origin https://git.umber.com/rjmcmahon/wireless-monitor.git
# Push to repository
git push -u origin main
# Or if your default branch is 'master':
# git push -u origin master
```
## Option 2: Add to Existing Repository
If you want to add this as a subdirectory to an existing repository:
```bash
# From the parent repository
cd /path/to/parent/repo
# Copy the template
cp -r wireless-monitor-template wireless-monitor
# Add to git
cd wireless-monitor
git init
git add -A
git commit -m "Add wireless monitor tool for ESP32 verification"
# Add as submodule (if parent repo uses submodules)
# Or just add files directly to parent repo
```
## Option 3: Standalone Repository
If you want this as a completely separate repository:
```bash
cd wireless-monitor-template
# Initialize git
git init
# Create .gitignore (already included)
# Add all files
git add -A
# Initial commit
git commit -m "Initial commit: Linux wireless monitor
A C program using GNU Automake for capturing and parsing 802.11 WiFi
frame headers in monitor mode. Designed to verify ESP32 monitor code
by comparing Linux vs ESP32 frame parsing."
# Add remote (replace with your actual repository URL)
git remote add origin https://git.umber.com/rjmcmahon/wireless-monitor.git
# Push
git branch -M main # Or 'master' if that's your default
git push -u origin main
```
## Building on Raspberry Pi 5
After cloning the repository:
```bash
# Clone repository
git clone https://git.umber.com/rjmcmahon/wireless-monitor.git
cd wireless-monitor
# Run build script
./build_pi5.sh
# Or manually:
./autogen.sh
./configure
make
```
## Repository Structure
```
wireless-monitor/
├── .gitignore
├── configure.ac
├── Makefile.am
├── autogen.sh
├── build_pi5.sh # Automated build script for Pi 5
├── README.md
├── BUILD_PI5.md # Build instructions
├── VERIFICATION_GUIDE.md # ESP32 verification guide
└── src/
├── Makefile.am
├── main.c
├── monitor.c
├── monitor.h
├── capture.c
├── capture.h
├── frame_parser.c
└── frame_parser.h
```
## Git Workflow
```bash
# Make changes
# ... edit files ...
# Stage changes
git add -A
# Commit
git commit -m "Description of changes"
# Push
git push origin main
```