readme.md

CONFIG

My personal setup of dotfiles and applications

---

📖 Table of Contents

• 📖 Table of Contents
• 📍 Overview
• 📦 Prerequisites
• 📂 Repository Structure
• 🚀 Getting Started
  • 🔧 Installation
• 🤝 Contributing
• 📄 License

---

📍 Overview

This repository contains a collection of dotfiles and scripts for setting up a development environment quickly and efficiently. The included scripts automate the process of installing necessary applications and configuring your system to your preferences.

---

📦 Prerequisites

• Unix-like operating system (MacOS, Linux, etc.)
• git installed on your machine
• curl or wget for downloading files (if not included in the install script)

---

📂 Repository Structure

└── config/
    ├── .config/
    │   ├── karabiner/
    │   │   ├── automatic_backups/
    │   │   └── karabiner.json
    │   ├── nvim/
    │   │   ├── after/
    │   │   ├── colors/
    │   │   ├── init.vim
    │   │   ├── macos.vim
    │   │   ├── maps.vim
    │   │   ├── plug.vim
    │   │   └── windows.vim
    │   ├── sheldon/
    │   │   └── plugins.toml
    │   └── starship.toml
    ├── init/
    │   ├── vscode_extensions.json
    │   └── vscode_settings.json
    ├── scripts/
    │   ├── fresh.sh
    │   ├── git_config.sh
    │   ├── macos.sh
    │   ├── ssh.sh
    │   └── vscode.sh
    └── setup/
        ├── aliases
        ├── colors
        ├── editorconfig
        ├── exports
        ├── extra
        ├── functions
        ├── gitconfig
        ├── gitignore
        └── zshrc

---

🚀 Getting Started

🔧 Installation

1. Clone the config repository:

git clone https://github.com/johnie/config

2. Change to the project directory:

cd config

3. Run the Install Script

chmod +x install.sh
./install.sh

---

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests.

Contributing Guidelines

Click to expand

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone <your-forked-repo-url>

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear and concise message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

---

📄 License

This project is protected under the MIT License.