|
1 | 1 | # Unitial
|
2 | 2 |
|
3 |
| -Automatic initialize environment for Unix-like operating system! |
| 3 | +Automatically initialize the environment for Unix-like operating systems! |
4 | 4 |
|
5 | 5 | ## Introduction
|
6 | 6 |
|
7 |
| -A set of scripts and configs to initialize the environment for Unix-like OS, |
8 |
| - |
9 |
| -Not fully tested but should work on FreeBSD, most of Linux distros and macOS. |
10 |
| - |
11 |
| -Feel free to fork, send pull request and feedback, but do not erase author info please. |
12 |
| - |
13 |
| -Questions and suggestions are welcome. |
| 7 | +Unitial is a shell scripts and a collection of configurations designed to set up a productive environment for Unix-like operating systems. Although not fully tested, it should work on FreeBSD, most Linux distributions, and macOS. Feel free to fork, contribute via pull requests, and provide feedback, but please retain the author information. Questions and suggestions are welcome. |
14 | 8 |
|
15 | 9 | ## Requirements
|
16 | 10 |
|
17 |
| -For FreeBSD, there is no additional requirements, please use the built-in `fetch` command. |
18 |
| - |
19 |
| -On other unix environment, please prepare `curl` or `wget`, so that the install script can download other files properly. |
| 11 | +- FreeBSD: No additional requirements; please use the built-in `fetch` command. |
| 12 | +- Other Unix environments: Ensure `curl` or `wget` is installed so that the installation script can download other files properly. |
20 | 13 |
|
21 | 14 | ## Installation
|
22 | 15 |
|
23 |
| -Install by this one line command if you have `curl`: |
| 16 | +To install with `curl`: |
24 | 17 |
|
25 | 18 | ```sh
|
26 | 19 | curl -Lo- https://github.com/PeterDaveHello/Unitial/raw/master/setup.sh | bash
|
27 | 20 | ```
|
28 | 21 |
|
29 |
| -If you don't have `curl` but your have `wget`: |
| 22 | +To install with `wget`: |
30 | 23 |
|
31 | 24 | ```sh
|
32 | 25 | wget -O- https://github.com/PeterDaveHello/Unitial/raw/master/setup.sh | bash
|
33 | 26 | ```
|
34 | 27 |
|
35 |
| -If you are using FreeBSD without both `wget` and `curl`, try: |
| 28 | +For FreeBSD users without both `wget` and `curl`, try: |
36 | 29 |
|
37 | 30 | ```sh
|
38 | 31 | fetch -o- https://github.com/PeterDaveHello/Unitial/raw/master/setup.sh | bash
|
39 | 32 | ```
|
40 | 33 |
|
41 |
| -(You can replace the url with a shorter one: https://git.io/Unitial) |
| 34 | +(You can replace the URL with a shorter one: https://git.io/Unitial) |
42 | 35 |
|
43 |
| -All the works will be done in seconds. |
| 36 | +The installation process will complete in seconds. |
44 | 37 |
|
45 |
| -If you know how to use git and already installed it, you can also clone this repo, but there is no need. |
| 38 | +If you know how to use git and have already installed it, you can also clone this repo, but there is no need. |
46 | 39 |
|
47 | 40 | ## What's in it?
|
48 | 41 |
|
49 |
| -Bash/tcsh/csh/zsh Shell: |
50 |
| -auto completion, useful alias, keymap issue for many users, because BASH is my major shell and I seldom use zsh, bash's feature will be more than others. |
51 |
| - |
52 |
| -Vim: |
53 |
| -useful setting, status bar and comfortable color scheme |
54 |
| - |
55 |
| -Git: |
56 |
| -useful alias and setting, gitignore(global), auto completion, diff-highlight |
57 |
| - |
58 |
| -SSH: |
59 |
| -useful setting, including optimization for X11 forwarding, TCPKeepalicve, compression, and multiplexing! |
60 |
| - |
61 |
| -irssi: |
62 |
| -connection info for oftc and freenode, channel config example |
63 |
| - |
64 |
| -tmux: |
65 |
| -Useful status bar including avg load, color adjustment |
66 |
| - |
67 |
| -others: |
68 |
| - |
69 |
| -- aria2c |
70 |
| -- wget |
71 |
| -- curl |
72 |
| -- tig |
73 |
| -- w3m |
74 |
| -- php_cs |
75 |
| -- markdownlint |
76 |
| -- editorconfig |
| 42 | +- Shell configurations (Bash, tcsh, csh, zsh): |
| 43 | + - Auto completion |
| 44 | + - Useful aliases |
| 45 | + - Keymap issue fixes for many users (note: BASH is the primary shell, and zsh is used less often, so bash features are more comprehensive) |
| 46 | +- Vim: Useful settings, status bar, and comfortable color scheme |
| 47 | +- Git: Helpful aliases and settings, gitignore (global), auto-completion, diff-highlight |
| 48 | +- SSH: Valuable settings, including optimization for X11 forwarding, TCPKeepalive, compression, and multiplexing! |
| 49 | +- irssi: Connection info for OFTC and Freenode, channel config example |
| 50 | +- tmux: Informative status bar including average load, color adjustment |
| 51 | +- Others: |
| 52 | + - aria2c: Optimized download settings for improved performance and user experience |
| 53 | + - wget: Enhanced download reliability, user agent configuration, and retry options |
| 54 | + - curl: Improved connection handling, user agent customization, and retry strategies |
| 55 | + - tig: Personalized colors and line graphics for better readability |
| 56 | + - w3m: Tailored colors and appearance for an enhanced browsing experience |
| 57 | + - php_cs: Custom PHP-CS-Fixer rules for consistent coding style |
| 58 | + - markdownlint: Configured Markdown linting rules for better writing quality |
| 59 | + - editorconfig: Consistent coding styles across different file types |
| 60 | + - lftp: Debugging options and user agent customization for better file transfers |
| 61 | + - gtab: Fine-tuned input method settings for efficient text input |
| 62 | + - inputrc: User-friendly keybindings for readline |
| 63 | + - xinputrc: Input method settings (commented out by default) for potential customization |
0 commit comments