Kataglyphis-RustProjectTemplate

A template .

For official docs follow this link.

About The Project • Getting Started • License • Literature

Table of Contents

1. About The Project
   • Key Features
   • Dependencies
   • Useful tools
2. Getting Started
   • Prerequisites
   • Installation
3. Tests
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements
9. Literature

About The Project

This project is a template.

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.

Useful tools

• cargo-outdated

Getting Started

Prerequisites

Installation

1. Clone the repo

   git clone --recurse-submodules [email protected]:Kataglyphis/....git

Tests

Run

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

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

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_ - [email protected]

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

Acknowledgements

Literature

Some very helpful literature, tutorials, etc.