|
1 | 1 | shell-utils |
2 | 2 | =========== |
3 | 3 |
|
4 | | -bash,zsh,sh utils functions and aliases, as well as some tools and maybe contain the dot-files in the future |
| 4 | +Introduction |
| 5 | +------------ |
| 6 | + |
| 7 | +This project is intend to serve you a bunch of convenient stuff include alias, |
| 8 | +functions, etc., which makes life easier. |
| 9 | + |
| 10 | +Install |
| 11 | +------- |
| 12 | + |
| 13 | +### automatic |
| 14 | + |
| 15 | +Open terminal and type: |
| 16 | + |
| 17 | + curl -L https://github.com/oxnz/shell-utils/install.sh | sh |
| 18 | + |
| 19 | +or |
| 20 | + |
| 21 | + wget https://github.com/oxnz/shell-utils/install.sh -O - | sh |
| 22 | + |
| 23 | +and this will append the source command in your .bashrc and .zshrc, then create |
| 24 | +the `.shell` directory under your $HOME. |
| 25 | + |
| 26 | +### manual |
| 27 | + |
| 28 | +1. Clone the repository: |
| 29 | + |
| 30 | + git clone https://github.com/oxnz/shell-utils.git ~/.shell |
| 31 | + |
| 32 | +2. Source bootstrap file in the dot-shrc file: |
| 33 | + |
| 34 | + echo '. ~/.shell/bootstrap.sh' >> ~/.bashrc |
| 35 | + echo '. ~/.shell/bootstrap.sh' >> ~/.zshrc |
| 36 | + |
| 37 | +3. Already done, just open a new terminal and testing the amazing stuff. |
| 38 | + |
| 39 | +Customize |
| 40 | +--------- |
| 41 | + |
| 42 | +If you want to override any of the default behaviors, just add the stuff in the custom/ directory. |
| 43 | + |
| 44 | +Update |
| 45 | +------ |
| 46 | + |
| 47 | +There's two strategies for update: |
| 48 | + |
| 49 | +* manually: |
| 50 | + |
| 51 | + skel update |
| 52 | + |
| 53 | +* automatically: |
| 54 | + |
| 55 | + skel set autoupdate=true |
| 56 | + |
| 57 | +If you don't want check upgrade automatically: |
| 58 | + |
| 59 | + skel set autoupdate=false |
| 60 | + |
| 61 | +Uninstall |
| 62 | +--------- |
| 63 | + |
| 64 | + skel destroy |
| 65 | + |
| 66 | +Infrastructure |
| 67 | +-------------- |
| 68 | + |
| 69 | +~/.shell |
| 70 | + |___ rc/ # source entry directory, this directory is generated |
| 71 | + |___ skel/ # shell-utils manager |
| 72 | + |___ doc/ # documentation |
| 73 | + |___ bin/ # this path will add to the PATH variable |
| 74 | + |___ src/ # source code for libs and plugins |
| 75 | + |___ lib/ # library stuff used by plugin manager and dependencies |
| 76 | + |___ opt/ # plugins would be here |
| 77 | + |___ var/ # data files |
| 78 | + |___ core/ # source this directory unconditionally |
| 79 | + |___ ext/ # extension utils |
| 80 | + |___ tool/ # tools used for generate docs, check codes, etc. |
| 81 | + |___ test/ # test suits |
| 82 | + |___ custom/ # customize script |
| 83 | + |___ .git/ # git directory |
| 84 | + |___ .gitignore # ignore the .git and custom directory |
| 85 | + |
| 86 | +For more details, please see doc/infrastructure |
| 87 | + |
| 88 | +Notes |
| 89 | +----- |
| 90 | + |
| 91 | +This section is intend leave blank |
| 92 | + |
| 93 | +Contribute |
| 94 | +---------- |
| 95 | + |
| 96 | +If you have ideas on how to make the configuration easier to maintain (and faster), don’t hesitate to fork and send pull requests! |
| 97 | + |
| 98 | +Any impovement is welcome |
| 99 | + |
| 100 | +### Guide lines: |
| 101 | + 1. the plugin manager should keep in one top directory |
| 102 | + 2. install script should be robust and most compatible |
| 103 | + 3. the startup should contain debug functionability such as list the loaded functions and libraries |
| 104 | + 4. should keep effeciency in mind, so compile needed |
| 105 | + 5. code should be documented, generate help file from source file |
| 106 | + 6. interface skel help func to system access, such as help in bash and run-help in zsh |
| 107 | + 7. cause there's many perl script in /bin and /usr/bin, so the skel implemented in perl, if needed, can be rewrite in C/C++ |
| 108 | + |
| 109 | +License |
| 110 | +------- |
| 111 | + |
| 112 | +Shell-utils is distributed under the terms of the MIT license. |
| 113 | + |
| 114 | +See LICENSE and COPYRIGHT for details |
0 commit comments