|
1 | 1 | # SHeCoRe - Shell Configuration Restorer
|
2 | 2 |
|
3 |
| -Set of scripts and config files for restoring shell/environment settings. |
| 3 | +Sample scripts and config files for restoring (or setting) shell and environment to your default, favorite state. |
4 | 4 |
|
5 | 5 | This tool has been prepared for private purpose so probably is useless for the rest of the world. In case you find it useful please find some short manual in this document.
|
6 | 6 |
|
7 | 7 | Currently the scripts provide restoration of following settings:
|
8 | 8 |
|
9 |
| -* bash settings [in progress] - aliases, prompt, environment variables |
10 |
| -* directories [in progress] - set of directories one wants to have on each development/personal/work machine |
11 |
| -* installed applications [to be done] - automatic application installation (Ubuntu apt and CentOS yum supported) |
| 9 | +* bash settings - aliases, prompt, environment variables or whatever you can place in *~/.bashrc* |
| 10 | +* directories - list of directories you want to always have on each development/personal/work machine |
| 11 | +* desired applications [to be done] - automatic application installation (Ubuntu apt and CentOS yum/dnf supported) |
12 | 12 |
|
13 | 13 | ## Repository content
|
14 | 14 |
|
| 15 | +From the user point of vue this repository contains two types of items: |
| 16 | + |
| 17 | +* scripts (especially main *shecore.sh*) |
| 18 | +* profiles (different lists of settings to be applied) |
| 19 | +* README file (document you're reading now) |
| 20 | + |
15 | 21 | ### Scripts
|
16 | 22 |
|
| 23 | +Main script that everyone should use is *shecore.sh*. This script is responsible for applying selected profiles. It also has the most up-to-date usage description. |
| 24 | + |
| 25 | +Scripts placed inside *./scripts* directory contains implementation of different functions used by *shecore.sh* and should never be called directly. |
| 26 | + |
17 | 27 | ### Profiles (folders with settings)
|
18 | 28 |
|
19 |
| -## Fetching, configuration and installation |
| 29 | +Inside *./profiles* directory one can find some sample profiles and should also create it's own profiles when needed. Each profile is a separate directory and consists of following files: |
| 30 | + |
| 31 | +* apps - list of applications to be installed on host |
| 32 | +* bash - desired addition to user's *~/.bashrc* file (it will be placed inside separate file and sourced from *~/.bashrc*) |
| 33 | +* dirs - list of directories to be created inside $HOME (creation of dirs in other locations currently not prepared) |
20 | 34 |
|
21 |
| -TODO |
| 35 | +Profile does not have to contain all of these files but only used ones. |
22 | 36 |
|
23 |
| -## Usage |
| 37 | +## Fetching, installation and usage |
24 | 38 |
|
25 |
| -TODO |
| 39 | +*SheCoRe* is not a complex tools and does not need any installation process. To use it just download the repository and call *shecore.sh* script to create new profile or apply one/some of available profiles. |
26 | 40 |
|
27 |
| -## Synchronization |
| 41 | +```bash |
| 42 | +git clone https://github.com/markamdev/shecore |
| 43 | +cd shecore |
| 44 | +./shecore.sh |
| 45 | +``` |
28 | 46 |
|
29 |
| -TODO |
| 47 | +If you find this project usefull in your case then just fork it, upload your profiles and use on your machines. |
30 | 48 |
|
31 | 49 | ## Author
|
32 | 50 |
|
|
0 commit comments