mirror of
https://github.com/tuxdotrs/tawm.git
synced 2025-07-05 20:56:33 +05:30
docs: update README.md
This commit is contained in:
106
README.md
106
README.md
@ -1,5 +1,5 @@
|
||||
<h3 align="center">
|
||||
tux's Nix Flake
|
||||
tux's awesomeWM config
|
||||
</h3>
|
||||
<p align="center">
|
||||
<a href="https://wakatime.com/badge/user/012e8da9-99fe-4600-891b-bd9d8dce73d9/project/312e6509-0e4f-47b7-b5de-54985b546702" target="_blank"><img alt="home" src="https://wakatime.com/badge/user/012e8da9-99fe-4600-891b-bd9d8dce73d9/project/312e6509-0e4f-47b7-b5de-54985b546702.svg"></a>
|
||||
@ -10,102 +10,28 @@
|
||||
<img src="https://github.com/user-attachments/assets/fc28c35f-b87a-4931-ae7f-c231a11fd1a3" alt="desktop">
|
||||
</p>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Hosts](#hosts)
|
||||
- [Installation](#installation)
|
||||
- [Components](#components)
|
||||
- [Showcase](#showcase)
|
||||
- [Pain](#spent-weeks-on-this-system-configuration-)
|
||||
|
||||
## Hosts
|
||||
|
||||
| | Type | Name | Hardware | Purpose |
|
||||
| --- | ------- | -------- | --------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| 💻 | Desktop | sirius | Ryzen 5 3600 - 64GB RAM - RTX 3080 TI | Multi-monitor desktop running Windows Subsystem for Linux. |
|
||||
| 🖥️ | Laptop | canopus | Ryzen 9 5900HS - 16 GB RAM - RTX 3060 | Optimized for productivity on the go and some gaming. |
|
||||
| 🖥️ | Server | homelab | Ryzen 7 8700G - 32 GB RAM - Radeon 780M | WIP |
|
||||
| ☁️ | VPS | arcturus | 4 Core - 8 GB RAM | Primary server responsible for exposing my homelab applications to the internet. |
|
||||
| 🥔 | VPS | alpha | 2 Core - 4 GB RAM | Monitors uptime and health status of all services across the infrastructure. |
|
||||
| 🥔 | Server | vega | Cortex A53 - 1 GB RAM | Running AdGuard Home for network-wide ad blocking. |
|
||||
| ☁️ | VPS | capella | 4 Core - 6 GB RAM | For running Minecraft, CS 2, Rust game servers. |
|
||||
| 📱 | VPS | rigel | S21 Ultra - 12 GB RAM | Yes, I run nix on my android device. lol |
|
||||
| ☁️ | VPS | node | i9-13900 - 64 GB RAM | Running Ethereum and BSC nodes. Currently in the process of migrating from Ubuntu. |
|
||||
|
||||
## Installation
|
||||
|
||||
Boot into NixOS bootable USB and then enter the following commands
|
||||
```nix
|
||||
# Add to your flake inputs
|
||||
tawm = {
|
||||
url = "github:tuxdotrs/tawm";
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
|
||||
# Add this in your HomeManager config
|
||||
{ inputs, ... }: {
|
||||
home.file = {
|
||||
".config/awesome" = {
|
||||
recursive = true;
|
||||
source = "${inputs.tawm.packages.x86_64-linux.default}";
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
# Clone this repositry
|
||||
git clone https://github.com/tuxdotrs/nix-config.git
|
||||
|
||||
# Navigate to the repository directory
|
||||
cd nix-config
|
||||
|
||||
# Install disko for disk partitioning
|
||||
nix-shell -p disko
|
||||
|
||||
# Partition the disk and make sure to replace DISK_PATH (eg. /dev/vda)
|
||||
disko --mode disko ./hosts/canopus/disko.nix --arg device '"DISK_PATH"'
|
||||
|
||||
# Generate the hardware.nix file for your system
|
||||
nixos-generate-config --no-filesystems --root /mnt
|
||||
|
||||
# Replace the hardware.nix with generated one
|
||||
cp /mnt/etc/nixos/hardware-configuration.nix ./hosts/canopus/hardware.nix
|
||||
|
||||
# Install
|
||||
nixos-install --root /mnt --flake .#canopus
|
||||
|
||||
# Reboot to your beautiful DE
|
||||
reboot
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
| | Wayland | Xorg |
|
||||
| ------------- | ------- | ---------------- |
|
||||
| DM | / | SDDM |
|
||||
| WM/DE | / | AwesomeWM |
|
||||
| Compositor | / | Picom (Jonaburg) |
|
||||
| Bar | / | Wibar |
|
||||
| Hotkeys | / | Awful |
|
||||
| Launcher | / | Rofi |
|
||||
| Notifications | / | Naughty |
|
||||
| Terminal | / | Wezterm |
|
||||
| Editor | / | Neovim |
|
||||
|
||||
## Showcase
|
||||
|
||||
### Desktop
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
### Neovim
|
||||
|
||||

|
||||
|
||||
### Floating Terminal
|
||||
|
||||

|
||||
|
||||
### Lazygit
|
||||
|
||||

|
||||
|
||||
### Telescope
|
||||
|
||||

|
||||
|
||||
### Firefox
|
||||
|
||||

|
||||
|
||||
## Spent weeks on this system configuration 😢
|
||||
|
||||
<div align="center">
|
||||
<img src="https://user-images.githubusercontent.com/97862450/265550523-2f66a8b6-4347-40af-89c6-12db3a61cc7c.jpeg" width="60%">
|
||||
</div>
|
||||
|
Reference in New Issue
Block a user