OSDN Git Service

update requirements section
[instantos/instantOS.git] / README.md
1 # suckless
2 my suckless "distro"
3
4 ## Installation
5
6 ```sh
7 curl https://raw.githubusercontent.com/paperbenni/suckless/master/install.sh | bash
8 ```
9 ### Installation including config files like .bashrc
10
11 #### WARNING THIS WILL OVERWRITE ANY EXISTING CONFIGURATION
12 ```sh
13 curl https://raw.githubusercontent.com/paperbenni/suckless/master/dotinstall.sh | bash
14 ```
15 ## This suckless collection is made up of
16 - Start menu: https://github.com/paperbenni/dmenu
17 - Window-Manager: https://github.com/paperbenni/dwm
18 - Terminal emulator: https://github.com/paperbenni/st
19 - Lock screen: https://github.com/paperbenni/slock
20
21 All of these are forks of their original [suckless](https://suckless.org) projects. 
22 Suckless programs are really basic , small and optimized programs that you are supposed to extend to suit your needs
23 (or use someone elses configuration if you don't want to learn c or/and apply a bunch of patches)
24
25 ## Requirements:
26 This requires an server, it does NOT work with wayland as it relies on x utilities
27
28 ## OS
29 It works on Arch and Ubuntu. 
30 Arch being my daily driver is more tested than Ubuntu, if you have any issues, just contact me,
31 the userbase being that small allows me to answer every single request.