Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] #175

Open
WeiYiAcc opened this issue Jun 27, 2024 · 0 comments
Open

[FEATURE] #175

WeiYiAcc opened this issue Jun 27, 2024 · 0 comments

Comments

@WeiYiAcc
Copy link

Dotter Configuration Guide

Problem Statement

I felt frustrated with the example files and documentation. Despite Dotter being an excellent and user-friendly software that should typically take 10 minutes to set up, the lack of a minimalist example led to issues. Specifically, an empty source folder preventing symlink creation made me mistakenly believe there was a Windows permission problem, wasting considerable time.

Proposed Solution

Optimize the documentation with a clear, minimal example.

Directory Structure

dotfiles
│
├── .dotter
│   ├── cache.toml
│   ├── global.toml
│   ├── local.toml
│   └── windows.toml
│
├── source_path
│   └── not_be_empty_path.file  # This is a file. Deployment fails if empty.
│
└── source_file

Run dotter deploy in the root directory. Note that dotter deploy -d will fail.

Configuration Files

global.toml

[settings]
default_target_type = "symbolic"

[package_name_1]
depends = []

Note: I intentionally didn't write package_name_2. If there are no dependencies, you can omit writing them all.

local.toml

includes = [".dotter/windows.toml"]
packages = ["package_name_1", "package_name_2"]

windows.toml

[package_name_1.files]
# This is the location for Windows
"source_flle" = "~/target_file"

[package_name_2.files]
"source_path" = "~/target_path"

Important Notes

  1. The source_path directory must not be empty. The presence of not_be_empty_path.file is crucial for successful deployment.
  2. The correct way to include modules is:
    includes = [".dotter/windows.toml"]

This guide aims to provide a clear, minimal example to help users avoid common pitfalls and quickly set up Dotter on Windows systems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant