Skip to content

Commit

Permalink
docs: add install.md page in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kremilly committed Nov 5, 2024
1 parent d6434ae commit 175feb9
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 10 deletions.
8 changes: 0 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
49 changes: 49 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 22 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
- 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

0 comments on commit 175feb9

Please sign in to comment.