I am batman
This commit is contained in:
145
README.md
Normal file
145
README.md
Normal file
@@ -0,0 +1,145 @@
|
||||
# 🖥️ ParanaOS
|
||||
|
||||
<!-- Desktop screenshots (actual images) -->
|
||||
<p align="center">
|
||||
<img src="imgs/260204_17h43m19s_screenshot.png" width="400" alt="Screenshot 1"/>
|
||||
<img src="imgs/260204_17h44m14s_screenshot.png" width="400" alt="Screenshot 2"/>
|
||||
<img src="imgs/260204_17h44m50s_screenshot.png" width="400" alt="Screenshot 3"/>
|
||||
<img src="imgs/260204_17h47m38s_screenshot.png" width="400" alt="Screenshot 4"/>
|
||||
<img src="imgs/260204_17h48m01s_screenshot.png" width="400" alt="Screenshot 5"/>
|
||||
<img src="imgs/260204_17h49m57s_screenshot.png" width="400" alt="Screenshot 6"/>
|
||||
<img src="imgs/260204_17h50m12s_screenshot.png" width="400" alt="Screenshot 7"/>
|
||||
<img src="imgs/260204_17h50m28s_screenshot.png" width="400" alt="Screenshot 8"/>
|
||||
<img src="imgs/260204_17h50m45s_screenshot.png" width="400" alt="Screenshot 9"/>
|
||||
<img src="imgs/260204_17h52m05s_screenshot.png" width="400" alt="Screenshot 10"/>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Welcome to my personal dotfiles repo! This setup uses [Nix Flakes](https://nixos.wiki/wiki/Flakes), modular shell/configuration management, and lightweight scripts to make my Linux environment highly reproducible, beautiful, and easy to customize.
|
||||
|
||||
**Features:**
|
||||
- 🎨 Powerlevel10k Zsh theme
|
||||
- 🐚 Modular configs for shell, editor, and more
|
||||
- ⚡ Automated install with Nix
|
||||
- 🖼️ Wallpapers for a custom look
|
||||
- 🛠️ Utility scripts
|
||||
- 🔒 Host-specific overrides
|
||||
|
||||
---
|
||||
|
||||
## Screenshots
|
||||
|
||||
<details>
|
||||
<summary>Click to expand all screenshots</summary>
|
||||
|
||||
<p align="center">
|
||||
<img src="imgs/260204_17h43m19s_screenshot.png" width="700" alt="Screenshot 1"/>
|
||||
<img src="imgs/260204_17h44m14s_screenshot.png" width="700" alt="Screenshot 2"/>
|
||||
<img src="imgs/260204_17h44m50s_screenshot.png" width="700" alt="Screenshot 3"/>
|
||||
<img src="imgs/260204_17h47m38s_screenshot.png" width="700" alt="Screenshot 4"/>
|
||||
<img src="imgs/260204_17h48m01s_screenshot.png" width="700" alt="Screenshot 5"/>
|
||||
<img src="imgs/260204_17h49m57s_screenshot.png" width="700" alt="Screenshot 6"/>
|
||||
<img src="imgs/260204_17h50m12s_screenshot.png" width="700" alt="Screenshot 7"/>
|
||||
<img src="imgs/260204_17h50m28s_screenshot.png" width="700" alt="Screenshot 8"/>
|
||||
<img src="imgs/260204_17h50m45s_screenshot.png" width="700" alt="Screenshot 9"/>
|
||||
<img src="imgs/260204_17h52m05s_screenshot.png" width="700" alt="Screenshot 10"/>
|
||||
</p>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Installation & Setup
|
||||
|
||||
### Prerequisites
|
||||
- **Linux machine** (tested with Arch, Ubuntu; works on most distros)
|
||||
- **[Nix](https://nixos.org/download.html)** package manager (see https://nixos.org for install instructions)
|
||||
- Optionally: [Home Manager](https://nix-community.github.io/home-manager/) for full home directory integration
|
||||
|
||||
### Step 1: Clone the repository
|
||||
|
||||
```sh
|
||||
git clone https://github.com/gibbyDev/.dotfiles>.git ~/.dotfiles
|
||||
cd ~/.dotfiles
|
||||
```
|
||||
|
||||
### Step 2: Install dependencies with Nix Flakes
|
||||
|
||||
If you don’t have flakes enabled, run:
|
||||
|
||||
```sh
|
||||
nix --experimental-features 'nix-command flakes' flake show
|
||||
```
|
||||
|
||||
Run the installer to rebuild system and home manager modules:
|
||||
|
||||
```sh
|
||||
chmod +x install.sh
|
||||
./install.sh
|
||||
```
|
||||
|
||||
Replace `<your-host>` with your hostname as defined in the `hosts/` directory.
|
||||
|
||||
### Step 3: Extras and Customization
|
||||
- Edit (or override) configs in `modules/` for shell, editor, etc.
|
||||
- Change wallpapers by replacing files in `wallpapers/`
|
||||
- Update host-specific settings in `hosts/`
|
||||
- Zsh theme: `.p10k.zsh` config for Powerlevel10k is included
|
||||
- Additional scripts can be run or extended from `scripts/`
|
||||
|
||||
---
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```text
|
||||
.
|
||||
├── flake.lock
|
||||
├── flake.nix
|
||||
├── hosts
|
||||
│ └── template/
|
||||
├── imgs
|
||||
├── modules
|
||||
│ ├── code/
|
||||
│ ├── default.nix
|
||||
│ ├── dolphin/
|
||||
│ ├── fastfetch/
|
||||
│ ├── firefox/
|
||||
│ ├── hyprland/
|
||||
│ ├── kitty/
|
||||
│ ├── misc/
|
||||
│ ├── nvim/
|
||||
│ ├── opencode/
|
||||
│ ├── rofi/
|
||||
│ ├── tmux/
|
||||
│ ├── virtualization/
|
||||
│ ├── waybar/
|
||||
│ ├── wlogout/
|
||||
│ └── yazi/
|
||||
├── .p10k.zsh
|
||||
├── README.md
|
||||
├── scripts
|
||||
└── wallpapers
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## FAQ & Troubleshooting
|
||||
- **How do I update everything?**
|
||||
- Pull latest: `git pull`
|
||||
- Re-run the Nix install process
|
||||
- **Where do I put overrides for my machine?**
|
||||
- Add files to the `hosts/` directory named after your hostname.
|
||||
- **How do I contribute or fork?**
|
||||
- Make your edits, then push to your fork or PR as needed!
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
MIT (or specify your own preferred license)
|
||||
|
||||
## Credits
|
||||
Big thanks to the Nix, Home Manager, and Powerlevel10k communities!
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user