Skip to content

docs: add project documentation and update #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maheshbhatiya73 merged 2 commits into from
Sep 10, 2025
Merged

docs: add project documentation and update #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9624068
docs: add project documentation and update
maheshbhatiya73 Sep 10, 2025
54443d6
Merge branch 'main' into dev
maheshbhatiya73 Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 76 additions & 23 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,96 @@
# === Rust build & cargo files ===
# Rust build artifacts
/target/
**/target/
**/*.rs.bk
Cargo.lock

# === IDE/editor folders ===
.idea/
# IDE and editor files
.vscode/
.idea/
*.swp
*.swo
*~

# === OS generated files ===
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

# === Logs, temp, runtime ===
# Logs
*.log
logs/
/var/log/eclipta/

# Runtime data
/run/eclipta/
*.json
/var/lib/eclipta/
/tmp/eclipta/

# Configuration files with sensitive data
config.yaml
*.key
*.pem
*.crt
*.p12

# eBPF compiled objects (keep source, ignore compiled)
*.o
*.so
*.skel.h

# Keep sample eBPF objects for testing
!bin/simple_trace.o
!bin/simple_xdp.o

# Database files
*.db
*.sqlite
*.sqlite3

# === Byproducts ===
# Backup files
*.bak
*.backup
*.old

# === Environment files ===
.env
.env.*
# Temporary files
*.tmp
*.temp

# Coverage reports
tarpaulin-report.html
lcov.info

# Profiling data
*.prof
perf.data*

# === Rust/Cargo specific ===
Cargo.lock # optional: keep it if you're building a binary (e.g., CLI), not a library
/.cargo/
# Documentation build
/book/
/docs/_build/

# Package files
*.tar.gz
*.zip
*.deb
*.rpm

# Local development
.env
.env.local
.env.*.local

# === Coverage/test tools ===
htmlcov/
# Test artifacts
test-results/
coverage/
*.lcov

# === Debug/profiler ===
*.profraw
*.profdata
flamegraph.svg
# eBPF development
vmlinux.h
*.ll
*.bc

/tests/*
/bin/*
# System files
/var/cache/eclipta/
/var/run/eclipta.pid
48 changes: 48 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Changelog

## [0.1.0] - 2025-01-27

### Added
- Complete project restructure for open source release
- Comprehensive documentation in `eclipta.yaml`
- Sample eBPF programs for testing
- Proper `.gitignore` configuration
- MIT License
- Updated installation script
- Clean project structure

### Changed
- Removed unnecessary directories (`bin/`, `ebpf-demo/`, `tests/`, `target/`)
- Updated `Cargo.toml` workspace configuration
- Streamlined README.md
- Reorganized project layout

### Removed
- Old binary files and demo programs
- Unnecessary test files
- Build artifacts and temporary files

### Project Structure
```
eclipta/
├── eclipta-cli/ # Main CLI application
├── examples/ebpf/ # Sample eBPF programs
├── bin/ # Compiled eBPF programs for testing
├── eclipta.yaml # Comprehensive documentation
├── README.md # Project overview
├── LICENSE # MIT License
├── install.sh # Installation script
└── .gitignore # Git ignore rules
```

### Sample eBPF Programs
- `simple_trace.c` - Basic tracepoint program
- `simple_xdp.c` - Basic XDP program
- Compiled versions available in `bin/` directory

### Documentation
- Complete command reference in `eclipta.yaml`
- Installation instructions
- Usage examples
- Development guidelines
- Troubleshooting guide
48 changes: 1 addition & 47 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[workspace]
members = [
"eclipta-cli",
"ebpf-demo/user"
"eclipta-cli"
]

resolver = "2"
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Mahesh Bhatiya

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading