Skip to content

Commit e9f47f6

Browse files
committed
README file update and some cleaning
1 parent 5c8ccce commit e9f47f6

File tree

4 files changed

+29
-100
lines changed

4 files changed

+29
-100
lines changed

README.md

+28-10
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,50 @@
11
# SHeCoRe - Shell Configuration Restorer
22

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.
44

55
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.
66

77
Currently the scripts provide restoration of following settings:
88

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)
1212

1313
## Repository content
1414

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+
1521
### Scripts
1622

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+
1727
### Profiles (folders with settings)
1828

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)
2034

21-
TODO
35+
Profile does not have to contain all of these files but only used ones.
2236

23-
## Usage
37+
## Fetching, installation and usage
2438

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.
2640

27-
## Synchronization
41+
```bash
42+
git clone https://github.com/markamdev/shecore
43+
cd shecore
44+
./shecore.sh
45+
```
2846

29-
TODO
47+
If you find this project usefull in your case then just fork it, upload your profiles and use on your machines.
3048

3149
## Author
3250

install.sh

-82
This file was deleted.

scripts/utils.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ _apply_dirs() {
8989
for dr in $(cat $1)
9090
do
9191
echo "... $dr"
92-
mkdir -p $dr
92+
mkdir -p ~/$dr
9393
done
9494
}
9595

sync.sh

-7
This file was deleted.

0 commit comments

Comments
 (0)