🦀 Kataglyphis-RustProjectTemplate 🦀

Collecting Rust best practices.

For official docs follow this link.

Table of Contents

• About The Project
  • Key Features
  • Dependencies
  • Useful tools
• Getting Started
  • Prerequisites
  • Installation
• Tests
• Run
• Docs
• Updates
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements
• Literature

About The Project

This project is about collecting experience in Rust.

Key Features

• Features are to be adjusted to your own project needs.

Category	Feature	Implement Status
Packaging agnostic	Binary only deployment	✔️
	Lore ipsum	✔️
Lore ipsum agnostic
	LORE IPSUM	✔️
	Advanced unit testing	🔶
	Advanced performance testing	🔶
	Advanced fuzz testing	🔶

Legend:

• ✔️ - completed
• 🔶 - in progress
• ❌ - not started

Dependencies

This enumeration also includes submodules.

If you just want the newest versions allowed by your current constraints (updates Cargo.lock only):

Update all: cargo update

Update versions in Cargo.toml cargo install cargo-edit cargo upgrade --dry-run --verbose cargo upgrade --incompatible

Useful tools

• cargo-outdated

Getting Started

Prerequisites

Installation

1. Clone the repo

   git clone --recurse-submodules git@github.com:Kataglyphis/Kataglyphis-RustProjectTemplate.git

Tests

Run

cargo run -- read --path ../README.md

Windows

cargo run --features gui_windows -- gui --backend dx12

# Vulkan backend
cargo run --features gui_windows -- gui --backend vulkan

# Auto-select (wgpu PRIMARY)
cargo run --features gui_windows -- gui --backend primary

Linux

# WGPU (recommended)
cargo run --features gui_linux -- gui --backend vulkan

# GTK demo
cargo run --features gui_unix -- gui

Docs

cargo doc --open

Updates

How to update all installed packages:

1. Install updater:

   cargo install cargo-update

2. Now update all packages:

   cargo install-update -a

Cameras

sudo v4l2-ctl --list-formats-ext -d /dev/video0
gst-launch-1.0 v4l2src device=/dev/video0 ! videoconvert ! autovideosink
gst-launch-1.0 videotestsrc ! video/x-raw,width=640,height=480,framerate=30/1 ! autovideosink

Roadmap

Upcoming :)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Contact

Jonas Heinle - @Cataglyphis_ - jonasheinle@googlemail.com

Project Link: https://github.com/Kataglyphis/...

Acknowledgements

Literature

Some very helpful literature, tutorials, etc.