27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
# Dotfiles Configuration
|
|
|
|
This repository contains configuration files for various tools and applications. These setup steps should follow an initial software installation via a Nix flake.
|
|
|
|
## Installation Steps
|
|
|
|
1. **Prepare the Environment**
|
|
- Ensure `/usr/local/bin` is included in your `$PATH` for access to scripts.
|
|
|
|
2. **Org File Tangling**
|
|
- Use Org mode in Emacs to tangle configuration files:
|
|
- `dotfiles.org`: For general configuration and environment variables.
|
|
- `scripts.org`: To install utility scripts to `/usr/local/bin`.
|
|
|
|
3. **Symlinking with Stow**:
|
|
- To symlink the `vimrc`, run:
|
|
`ln -s ~/.dotfiles/vimrc ~/.config/vim/vimrc`
|
|
- Since `emacs-config.org` is a literate configuration, it will require tangling into a usable Emacs configuration.
|
|
|
|
4. **Literate Emacs Configuration**:
|
|
- Open `emacs-config.org` in Emacs and export it to an Emacs Lisp file (typically `init.el` in your `.emacs.d` directory):
|
|
1. Open your configuration: `C-x C-f ~/.dotfiles/emacs-config.org`
|
|
2. Run `M-x org-babel-tangle` to extract the config into a `.el` file as needed. This performs the setup according to the tangling h
|
|
eaders in the Org file.
|
|
3. Ensure that the tangled `.el` file is correctly placed and loaded by Emacs, usually as `.emacs.d/init.el`.
|
|
|
|
- After symlinking and tangling, restart emacs to apply the new configurations and verify functionality.
|