From 07a996361ae810a09236885b4c5158d5a78c378d Mon Sep 17 00:00:00 2001 From: Asif Bacchus Date: Wed, 9 Jan 2019 04:43:27 -0700 Subject: [PATCH] updated and proofread readme --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fc9deef..7855931 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,19 @@ workstation, etc. Therefore, only a few core files applicable to nearly every conceivable installation are included here. This archive and included script are meant to supplement my article on setting -up a Debian base-system found at https://mytechiethoughts.com/ +up a Debian base-system found at my blog: [My +Techie-Thoughts](https://mytechiethoughts.com/) ## Included files -Please refer to the readme.md in each subdirectory for a list and description of +Please refer to the `readme.md` in each subdirectory for a list and description of each included file. ## The script file (customize.sh) The included script file copies all the files in this archive to the proper -locations on a default Debian system. It makes backups of your existing files -in-place with the extension *.original*. This simply saves you time and +locations on a default Debian Stretch system. It makes backups of your existing +files in-place with the extension *.original*. This simply saves you time and possible errors copying the files manually. The structure of this archive exactly mirrors a default Debian installation, so you can use that as a guide if you choose not to use the script. @@ -53,25 +54,31 @@ If you want to test out the script before having it update your actual system configuration, you can supply an alternate destination path. This is referred to as a 'Base Path' by the script and it will show a warning if this option is used. Please note, your 'Base Path' MUST have the same directory structure as -an actual system, so the expected directories must already exist or the script +an actual system. The expected directories must already exist or the script will just throw errors and not actually copy files. Let's assume you wanted to test the script and copy files to */testdir*. You -would do the following prepare the directory with the expected structure: +would do the following to prepare the directory with the expected structure: ```bash mkdir -p /testdir/root mkdir -p /testdir/etc/{skel,ssh,systemd} ``` -Then you could invoke the script as follows: +Then you could invoke the script as follows (assuming you made it executable as +described above): ```bash -customize.sh /testdir +./customize.sh /testdir ``` The script would then copy all files into */testdir* while mirroring the structure of a live system beneath that. Again, this is useful only for testing and will NOT update your actual system! -## Final thoughts \ No newline at end of file +## Final thoughts + +Hopefully this saves you some time and helps you standard your new system setups +with a few useful defaults. As always, if you have suggestions or want to leave +feedback for me, please do so on my [blog +post](https://mytechiethoughts.com/) related to this script! \ No newline at end of file