From 175feb984803886d85a1b81c075630648a3e5f7f Mon Sep 17 00:00:00 2001 From: Kremilly Date: Tue, 5 Nov 2024 07:54:52 -0300 Subject: [PATCH] docs: add install.md page in documentation --- docs/index.md | 8 -------- docs/install.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 24 ++++++++++++++++++++++-- 3 files changed, 71 insertions(+), 10 deletions(-) create mode 100644 docs/install.md diff --git a/docs/index.md b/docs/index.md index 5eca6a6..54f13dd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,11 +12,3 @@ DumpSync automates the process of creating dumps of a MySQL database at configur - **Flexible Configuration**: Customize settings through environment variables or command-line arguments based on your needs. - **Simple Restore Process**: Easily restore databases from existing dump files with minimal effort. - **Cross-Server Transfers**: Facilitate the migration of databases between different servers seamlessly. - -## Installation - -To install DumpSync using [crates.io](https://crates.io), run the following command: - -```bash -cargo install dumpsync -``` diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000..180cc2b --- /dev/null +++ b/docs/install.md @@ -0,0 +1,49 @@ +# Installation + +## Installing Rust on Different Operating Systems + +#### 1. Linux and macOS + +To install Rust on **Linux** and **macOS**, use the `rustup` script: + +1. Open your terminal. +2. Run the following command: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` + +3. Follow the on-screen instructions to complete the installation. +4. After the installation, restart the terminal and verify it by running: + +```bash +rustc --version +``` + +--- + +#### 2. Windows + +To install Rust on **Windows**, follow these steps: + +1. Download the `rustup-init.exe` installer from the official website: [https://rust-lang.org/tools/install](https://rust-lang.org/tools/install). +2. Run the installer and follow the setup instructions. +3. After installation, open **Command Prompt** or **PowerShell** and verify Rust with: + +```powershell +rustc --version +``` + +**Note:** Rust will be added to your PATH automatically during installation. + +--- + +## Installing DumpSync in your Operational System + +Once Rust is installed, use this command to install **DumpSync**: + +```bash +cargo install dumpsync +``` + +This will install **DumpSync** globally, allowing you to run it from any directory. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 11a317e..a82b142 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,11 @@ site_name: DumpSync repo_url: https://github.com/kremilly/DumpSync theme: name: material + features: + - navigation.instant + - navigation.sections + - navigation.footer + palette: - media: "(prefers-color-scheme: light)" scheme: default @@ -16,8 +21,23 @@ theme: name: Switch to light mode nav: - - Install: index.md + - Overview: index.md + - Install: install.md - Connection: connection.md - Settings: settings.md - Export: export.md - - Import: import.md \ No newline at end of file + - Import: import.md + +extra: + social: + - icon: fontawesome/solid/blog + link: https://kremilly.com + name: Blog + + - icon: fontawesome/brands/x-twitter + link: https://x.com/import_kremilly + name: Twitter + + generator: false + +copyright: Copyright © 2024 Kremillly \ No newline at end of file