37 lines
1.5 KiB
Rust
37 lines
1.5 KiB
Rust
//! # HomeDisk cloud server
|
|
//!
|
|
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
|
|
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
|
|
//! [total-lines]: https://img.shields.io/tokei/lines/github/MedzikUser/HomeDisk?style=for-the-badge&logo=github&color=fede00
|
|
//! [code-size]: https://img.shields.io/github/languages/code-size/MedzikUser/HomeDisk?style=for-the-badge&color=c8df52&logo=github
|
|
//! [ci]: https://img.shields.io/github/workflow/status/MedzikUser/HomeDisk/Rust/main?style=for-the-badge
|
|
//!
|
|
//! [home-screenshot]: https://i.imgur.com/x4Glw7w.png
|
|
//! [login-screenshot]: https://i.imgur.com/KpwY4nb.png
|
|
//!
|
|
//! [![github]](https://github.com/MedzikUser/HomeDisk)
|
|
//! [![docs-rs]](https://homedisk-doc.vercel.app)
|
|
//! [![total-lines]](https://github.com/MedzikUser/HomeDisk)
|
|
//! [![code-size]](https://github.com/MedzikUser/HomeDisk)
|
|
//! [![ci]](https://github.com/MedzikUser/HomeDisk/actions/workflows/rust.yml)
|
|
//!
|
|
//! ![home-screenshot]
|
|
//! ![login-screenshot]
|
|
//!
|
|
//! ## 👨💻 Building
|
|
//!
|
|
//! First clone the repository: `git clone https://github.com/MedzikUser/HomeDisk.git`
|
|
//!
|
|
//! ### Requirements
|
|
//! - [Rust](https://rust-lang.org)
|
|
//!
|
|
//! To build run the command: `cargo build --release`
|
|
//!
|
|
//! The compiled binary can be found in `./target/release/homedisk`
|
|
//!
|
|
//! ## Configure
|
|
//!
|
|
//! Go to [config](homedisk_types::config) module
|
|
|
|
#![doc(html_root_url = "https://homedisk-doc.medzik.xyz")]
|