pomp/pompup
1
0
Fork 0
Code Activity

simplify documentation and remove outdated ones

Browse source
This commit is contained in:
Kim, Jimin 2024-09-01 13:49:11 +09:00
parent 0ea0160614
commit 436a68a290
Signed by: pomp
GPG key ID: 2B516173EDD492EB
8 changed files with 16 additions and 456 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
.github/img/result3.png vendored
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 391 KiB

59
README.md
View file

@ -3,21 +3,27 @@
![language: Golang](https://img.shields.io/badge/go-blue?style=for-the-badge&logo=go&label=langauge) ![language: Golang](https://img.shields.io/badge/go-blue?style=for-the-badge&logo=go&label=langauge)
[![license](https://img.shields.io/github/license/developomp/pompup?style=for-the-badge&color=yellow)](./LICENSE) [![license](https://img.shields.io/github/license/developomp/pompup?style=for-the-badge&color=yellow)](./LICENSE)
<div align=center>
pompup is a personal one-click Arch Linux desktop setup utility tailor made for myself. pompup is a personal one-click Arch Linux desktop setup utility tailor made for myself.
<br /> ## Gallery
<!-- space characters used in buttons below are em space instead of regular spaces -->
**[<kbd> <br /> Gallery <br /> </kbd>][Gallery]**
**[<kbd> <br /> Hardware <br /> </kbd>][Hardware]**
![screenshot](.github/img/result1.png) ![screenshot](.github/img/result1.png)
--- ![result image 2](.github/img/result2.png)
</div> ## Wallpaper
![wallpaper](.github/img/wallpaper.png)
- from [a video](https://www.youtube.com/watch?v=QEWV6fiYaDU) at [Chillhop Music](https://www.youtube.com/channel/UCOxqgCwgOqC2lMqC5PYz_Dg)
- Artwork by [Jeff Östberg](https://jeffostberg.se)
- Animation by [Geneviève Delacroix](http://www.genevievelacroix.com)
- Applied Effects (in order)
- ImageGoNerd - [nordified](https://github.com/Schrodinger-Hat/ImageGoNord) (filtering option toggled)
- GIMP - gaussian blur 3.5
- GIMP - level 1 compression
## Software
| Software | Choice | | Software | Choice |
| -----------------------: | :------------------------------------------------------------------------------------------------------------------ | | -----------------------: | :------------------------------------------------------------------------------------------------------------------ |
@ -38,40 +44,7 @@ stuck.
## Usage ## Usage
I can't think of any valid use cases of this software outside my computer, It's not meant to run on your machine. Forget about it.
but here are the instructions to use it:
1. Install base Arch Linux
- https://wiki.archlinux.org/title/installation_guide
2. Create a non-root user and log in
- give sudo permission
- create home directory
- must not contain space in username
3. Download pompup
- using curl
```
curl pompup.developomp.com -Lo pompup
```
- using wget
```
wget pompup.developomp.com -O pompup
```
4. Make the file executable
```
chmod +x ./pompup
```
5. Run pompup
```
./pompup
```
[Gallery]: ./docs/gallery.md [Gallery]: ./docs/gallery.md
[Hardware]: ./docs/hardware/README.md [Hardware]: ./docs/hardware/README.md

28
docs/gallery.md
View file

@ -1,28 +0,0 @@
# Gallery
## No windows
![result image 1](../.github/img/result1.png)
## Some windows (with tiling enabled)
![result image 2](../.github/img/result2.png)
## Minimalism at its finest
![result image 3](../.github/img/result3.png)
## Sources
### Wallpaper
![wallpaper](../.github/img/wallpaper.png)
- source
- [a video](https://www.youtube.com/watch?v=QEWV6fiYaDU) from [Chillhop Music](https://www.youtube.com/channel/UCOxqgCwgOqC2lMqC5PYz_Dg)
- Artwork by [Jeff Östberg](https://jeffostberg.se)
- Animation by [Geneviève Delacroix](http://www.genevievelacroix.com)
- Applied Effects (in order)
- ImageGoNerd - [nordified](https://github.com/Schrodinger-Hat/ImageGoNord) (filtering option toggled)
- GIMP - gaussian blur 3.5
- GIMP - level 1 compression

52
docs/hardware/README.md
View file

@ -1,52 +0,0 @@
# Hardware
## Desktop
None
## Laptop
| name | model |
| ------: | :-------------------------------------------------------------------------------------------------------------------------------------- |
| Machine | secondhand [Lenovo Legion 5 15ARH05H](https://pcsupport.lenovo.com/us/en/products/laptops-and-netbooks/legion-series/legion-5-15arh05h) |
| CPU | AMD 4800H |
| GPU | Nvidia GeForce RTX 2060 Mobile |
| RAM | 64GB DDR4 3200MHz CL22 (32GBx2) |
| SSD 1 | 1TB [SK Hynix Platinum P41 M.2 NVMe SSD](https://ssd.skhynix.com/platinum_p41) |
| SSD 2 | secondhand 500GB [Samsung 980 NVMe SSD](https://semiconductor.samsung.com/consumer-storage/internal-ssd/980) |
## Peripherals
| peripheral | model | using since |
| -------------: | :--------------------------------------------------------------------------------------------------------------------- | :----------: |
| Mouse | secondhand [Razer Viper Ultimate](https://www.razer.com/gaming-mice/razer-viper-ultimate) | Aug 23, 2022 |
| Mousepad | [MAXTILL X5](https://prod.danawa.com/info/?pcode=6995089) (847x446mm) | Jul 4, 2023 |
| Headphone | secondhand [Arctis Nova Pro Wireless](https://steelseries.com/gaming-headsets/arctis-nova-pro-wireless-pc-playstation) | Dec 29, 2023 |
| Laptop Cooler | [ABKO NCORE NC500](http://ncore.co.kr/shop/product_item.php?ItId=2586312930) | ? |
| Keyboard | custom YMDK wings | Aug 13, 2022 |
| Drawing tablet | secondhand [wacom CTL-472 (one by wacom)](https://www.wacom.com/en-us/products/pen-tablets/one-by-wacom) | May 8, 2022 |
| Monitor | secondhand [DELL Alienware AW2521HF](https://www.rtings.com/monitor/reviews/dell/alienware-aw2521hf) | Feb 24, 2023 |
| Microphone | secondhand [Razer Seiren Mini](https://www.razer.com/streaming-microphones/razer-seiren-mini) | Aug 25, 2022 |
### Keyboard
![keyboard](./kbd.png)
- Parts & Accessories:
- [Case + PCB + Stabilizers + Cable](https://ko.aliexpress.com/item/1005003330613995.html) (white)
- [walnut wrist rest](https://ko.aliexpress.com/item/1005003629440348.html)
- [foam](https://ko.aliexpress.com/item/1005004451001013.html) (PCB & Bottom Foam)
- [Switches](https://www.aliexpress.com/item/1005003891937604.html) (Outemu silent peach)
- [Switch Film](https://www.aliexpress.com/item/1005002885279946.html) (HTV+PC 0.18mm)
- [Lube](https://www.aliexpress.com/item/1005002297786498.html) (GPL205 G0 7.6g)
- [Keycaps](https://www.aliexpress.com/item/1005003834670594.html) (GMK Geoma w/ Korean subs)
- Mods:
- no-stabilizer
### Keymap
- [json VIA configuration](./wings_hotswap.json)
- Layer 0
![keyboard layer 0](./kbd_layer_0.png)
- Layer 1
![keyboard layer 1](./kbd_layer_1.png)

BIN
docs/hardware/kbd.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 2.9 MiB

BIN
docs/hardware/kbd_layer_0.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 174 KiB

BIN
docs/hardware/kbd_layer_1.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 167 KiB

333
docs/hardware/wings_hotswap.json
View file

@ -1,333 +0,0 @@
{
"name": "Wings Hotswap",
"vendorProductId": 1498237301,
"macros": [
"{KC_LCTL,KC_LSFT,KC_TAB}",
"{KC_LCTL,KC_TAB}",
"{KC_LCTL,KC_LALT,KC_LEFT}",
"{KC_LCTL,KC_LALT,KC_RGHT}",
"{KC_LCTL,KC_W}",
"{KC_LCTL,KC_LSFT,KC_M}",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"layers": [
[
"KC_ESC",
"KC_1",
"KC_2",
"KC_3",
"KC_4",
"KC_5",
"KC_6",
"KC_7",
"KC_8",
"KC_9",
"KC_0",
"KC_MINS",
"KC_EQL",
"KC_BSPC",
"KC_NO",
"KC_TAB",
"KC_Q",
"KC_W",
"KC_E",
"KC_R",
"KC_T",
"KC_Y",
"KC_U",
"KC_I",
"KC_O",
"KC_P",
"KC_LBRC",
"KC_RBRC",
"KC_BSLS",
"KC_PGUP",
"KC_LSFT",
"KC_A",
"KC_S",
"KC_D",
"KC_F",
"KC_G",
"KC_H",
"KC_J",
"KC_K",
"KC_L",
"KC_SCLN",
"KC_QUOT",
"KC_NO",
"KC_ENT",
"KC_PGDN",
"KC_LSFT",
"KC_Z",
"KC_X",
"KC_C",
"KC_V",
"KC_B",
"KC_N",
"KC_M",
"KC_COMM",
"KC_DOT",
"KC_SLSH",
"KC_RCTL",
"KC_NO",
"KC_UP",
"KC_NO",
"KC_LCTL",
"KC_NO",
"KC_LALT",
"KC_NO",
"KC_SPC",
"KC_LGUI",
"FN_MO13",
"KC_NO",
"KC_NO",
"KC_RALT",
"KC_NO",
"KC_LEFT",
"KC_DOWN",
"KC_RGHT",
"KC_DEL"
],
[
"KC_GRV",
"KC_F1",
"KC_F2",
"KC_F3",
"KC_F4",
"KC_F5",
"KC_F6",
"KC_F7",
"KC_F8",
"KC_F9",
"KC_F10",
"KC_F11",
"KC_F12",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_MS_BTN5",
"KC_MS_BTN1",
"KC_MS_UP",
"KC_MS_BTN2",
"KC_MS_WH_UP",
"MACRO00",
"MACRO01",
"KC_UP",
"KC_TRNS",
"KC_MPLY",
"KC_MPRV",
"KC_MNXT",
"KC_TRNS",
"KC_HOME",
"KC_TRNS",
"KC_MS_BTN4",
"KC_MS_LEFT",
"KC_MS_DOWN",
"KC_MS_RIGHT",
"KC_MS_WH_DOWN",
"KC_VOLU",
"KC_LEFT",
"KC_DOWN",
"KC_RGHT",
"KC_MRWD",
"KC_MFFD",
"KC_NO",
"KC_TRNS",
"KC_END",
"KC_TRNS",
"KC_TRNS",
"MACRO04",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_VOLD",
"MACRO05",
"MACRO02",
"MACRO03",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_NO",
"KC_HANJ",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_PSCR"
],
[
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS"
],
[
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_NO",
"KC_NO",
"KC_TRNS",
"KC_NO",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS",
"KC_TRNS"
]
],
"encoders": []
}