From 054a1ec3bd44cd0a91a9671ee2a7c834ccf56bc3 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Mon, 20 Aug 2018 17:52:24 -0400 Subject: [PATCH 01/11] add different scenarios to the Quickstart section --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dcddc872c..bf4c216df 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,19 @@ Keep your application settings in sync. ## Quickstart +Instructions for three common use cases are below. + +* **Scenario 1** is the quickest and easiest but gives you no control over +which applications get synced +* **Scenario 2** is also quick and easy and gives you control over which applications +are synced +* **Scenario 3** is for the many unfortunate souls that never bothered to sync +the configurations files on the different machines they work on and are ready +for Mackup to end their misery. + +**Scenario 1:** You want to push **all** configuration settings from **all** +supported applications from one machine out to your other machines: + If you have [Dropbox](https://www.dropbox.com) installed and want to use it to save your config files, that's super easy. @@ -63,7 +76,49 @@ mackup restore Done! -You can find more detailed instructions in [INSTALL.md](INSTALL.md). +You can find more detailed installation instructions in [INSTALL.md](INSTALL.md). + +**Scenario 2:** You want to push configuration settings from **some** applications +from one machine to your other machines. + +Let's say you want to share just your bash configuration files with +your other machines. Simply create a file in your home directory +named `.mackup.cfg` and add the following two lines to it with your +favorite text editor: + +``` +[applications_to_sync] +bash +``` + +Save the file and then run the same commands given in Scenario 1 +above to install andsync your apps. Done! + +As you get more comfortable with Mackup and want to add new +applications to sync, simply add the name of the supported application +to the `.mackup.cfg` to the end of the file on a new line by itself. +You can also easily add unsupported applications as well. + +Learn more about modifying and customizing Mackup in [the documentation](doc/README.md). + +**Scenario 3:** You want to merge the configuration settings of two or +more machines. + +For example, let's say your bash configuration on Machine A is different +than the bash configuration on Machine B. You have some bash settings +on Machine A (like useful aliases) that you want to move over to +Machine B. But you also have settings on Machine B that you want to +move over to Machine A. + +The problem is that if you use Mackup to send Machine A's bash configuration settings +to Machine B, you will permanently lose any configurations that were on +Machine B but not on Machine A. + +You might decide you don't care about merging app configurations and can live with replacing +one machine's configuration with another. If so, just follow scenario 1 or 2 above. + +Otherwise, if you want to keep configuration settings from two or more +different machines, we have provided [a guide in our documentation](doc/configuration_merge_guide.md) ## Usage From dac75c3811aa6d4339c3053c3ce9ca642bc76e25 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Mon, 20 Aug 2018 18:28:56 -0400 Subject: [PATCH 02/11] Update README.md made language more specific --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf4c216df..a9f9f3509 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ Keep your application settings in sync. Instructions for three common use cases are below. * **Scenario 1** is the quickest and easiest but gives you no control over -which applications get synced +which applications are shared out for syncing * **Scenario 2** is also quick and easy and gives you control over which applications -are synced +are shared out for syncing * **Scenario 3** is for the many unfortunate souls that never bothered to sync the configurations files on the different machines they work on and are ready for Mackup to end their misery. From a4348c36908a6a52977376c0056026b5c51c0866 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Tue, 21 Aug 2018 22:47:24 -0400 Subject: [PATCH 03/11] fix formatting error --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a9f9f3509..bc2264412 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,15 @@ Keep your application settings in sync. ## Quickstart Instructions for three common use cases are below. - -* **Scenario 1** is the quickest and easiest but gives you no control over +* Scenario 1: is the quickest and easiest but gives you no control over which applications are shared out for syncing -* **Scenario 2** is also quick and easy and gives you control over which applications +* Scenario 2: is also quick and easy and gives you control over which applications are shared out for syncing -* **Scenario 3** is for the many unfortunate souls that never bothered to sync +* Scenario 3: is for the many unfortunate souls that never bothered to sync the configurations files on the different machines they work on and are ready for Mackup to end their misery. - **Scenario 1:** You want to push **all** configuration settings from **all** -supported applications from one machine out to your other machines: +supported applications from one machine out to your other machines: If you have [Dropbox](https://www.dropbox.com) installed and want to use it to save your config files, that's super easy. @@ -111,11 +109,12 @@ Machine B. But you also have settings on Machine B that you want to move over to Machine A. The problem is that if you use Mackup to send Machine A's bash configuration settings -to Machine B, you will permanently lose any configurations that were on +to Machine B, you will permanently lose any configurations that were on Machine B but not on Machine A. -You might decide you don't care about merging app configurations and can live with replacing -one machine's configuration with another. If so, just follow scenario 1 or 2 above. +You might decide you don't care about merging app configurations and can live with +replacing one machine's configuration with another. If so, just follow scenario 1 or +2 above. Otherwise, if you want to keep configuration settings from two or more different machines, we have provided [a guide in our documentation](doc/configuration_merge_guide.md) From 410ab6dd92f52a59e33e1c4d20ee794b2b14289f Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Tue, 21 Aug 2018 22:52:19 -0400 Subject: [PATCH 04/11] fix formatting errors --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc2264412..5202f518b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ Keep your application settings in sync. - [Where can I find more information](#where-can-i-find-more-information) ## Quickstart - Instructions for three common use cases are below. * Scenario 1: is the quickest and easiest but gives you no control over which applications are shared out for syncing @@ -117,7 +116,8 @@ replacing one machine's configuration with another. If so, just follow scenario 2 above. Otherwise, if you want to keep configuration settings from two or more -different machines, we have provided [a guide in our documentation](doc/configuration_merge_guide.md) +different machines, we have provided +[a guide in our documentation](doc/configuration_merge_guide.md) ## Usage From 2080c4fddf13ce9f8e94a83a4c5ff15264349e8d Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Tue, 21 Aug 2018 23:01:03 -0400 Subject: [PATCH 05/11] fix formatting errors --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5202f518b..9aecfd227 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,9 @@ Keep your application settings in sync. - [Where can I find more information](#where-can-i-find-more-information) ## Quickstart + Instructions for three common use cases are below. + * Scenario 1: is the quickest and easiest but gives you no control over which applications are shared out for syncing * Scenario 2: is also quick and easy and gives you control over which applications @@ -28,8 +30,9 @@ are shared out for syncing * Scenario 3: is for the many unfortunate souls that never bothered to sync the configurations files on the different machines they work on and are ready for Mackup to end their misery. + **Scenario 1:** You want to push **all** configuration settings from **all** -supported applications from one machine out to your other machines: +supported applications to get synced: If you have [Dropbox](https://www.dropbox.com) installed and want to use it to save your config files, that's super easy. @@ -76,7 +79,7 @@ Done! You can find more detailed installation instructions in [INSTALL.md](INSTALL.md). **Scenario 2:** You want to push configuration settings from **some** applications -from one machine to your other machines. +from one machine to others for syncing. Let's say you want to share just your bash configuration files with your other machines. Simply create a file in your home directory @@ -112,8 +115,8 @@ to Machine B, you will permanently lose any configurations that were on Machine B but not on Machine A. You might decide you don't care about merging app configurations and can live with -replacing one machine's configuration with another. If so, just follow scenario 1 or -2 above. +replacing one machine's configuration with another. If so, just follow scenario +1 or 2 above. Otherwise, if you want to keep configuration settings from two or more different machines, we have provided From f42f9ae18ba73ad804f43a171fb3be26ca19b902 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Tue, 21 Aug 2018 23:04:34 -0400 Subject: [PATCH 06/11] reinsert blank line between list items --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9aecfd227..145712e9c 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,10 @@ Instructions for three common use cases are below. * Scenario 1: is the quickest and easiest but gives you no control over which applications are shared out for syncing + * Scenario 2: is also quick and easy and gives you control over which applications are shared out for syncing + * Scenario 3: is for the many unfortunate souls that never bothered to sync the configurations files on the different machines they work on and are ready for Mackup to end their misery. From 2e8ca9edddae246207cd18ad704e73a6449a5ef7 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Tue, 21 Aug 2018 23:08:10 -0400 Subject: [PATCH 07/11] try something different with bullet list --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 145712e9c..e83355f1b 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,9 @@ Keep your application settings in sync. Instructions for three common use cases are below. -* Scenario 1: is the quickest and easiest but gives you no control over -which applications are shared out for syncing - -* Scenario 2: is also quick and easy and gives you control over which applications -are shared out for syncing - -* Scenario 3: is for the many unfortunate souls that never bothered to sync -the configurations files on the different machines they work on and are ready -for Mackup to end their misery. +* Scenario 1: is the quickest and easiest but gives you no control over which applications are shared out for syncing +* Scenario 2: is also quick and easy and gives you control over which applications are shared out for syncing +* Scenario 3: is for the many unfortunate souls that never bothered to syn the configurations files on the different machines they work on and are ready for Mackup to end their misery. **Scenario 1:** You want to push **all** configuration settings from **all** supported applications to get synced: From 76dfbfe34e3b442e9e5b234feddca92b29ed39f9 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Tue, 21 Aug 2018 23:14:15 -0400 Subject: [PATCH 08/11] another attempted fix at unordered list --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e83355f1b..84c93815c 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,13 @@ Keep your application settings in sync. Instructions for three common use cases are below. -* Scenario 1: is the quickest and easiest but gives you no control over which applications are shared out for syncing -* Scenario 2: is also quick and easy and gives you control over which applications are shared out for syncing -* Scenario 3: is for the many unfortunate souls that never bothered to syn the configurations files on the different machines they work on and are ready for Mackup to end their misery. +* Scenario 1: is the quickest and easiest but gives you no control over + which applications are shared out for syncing +* Scenario 2: is also quick and easy and gives you control over which + applications are shared out for syncing +* Scenario 3: is for the many unfortunate souls that never bothered to sync + the configurations files on the different machines they work on and are + ready for Mackup to end their misery. **Scenario 1:** You want to push **all** configuration settings from **all** supported applications to get synced: From 164190f1eb2f6de9b3c1a397e2c9137f1339e742 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Wed, 22 Aug 2018 01:06:55 -0400 Subject: [PATCH 09/11] got it. use vim with linter from now on --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 84c93815c..a4d4f6d01 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Keep your application settings in sync. - [Quickstart](#quickstart) - [Usage](#usage) - [What does it do](#what-does-it-do) -- [Bullsh*t, what does it really do to my files](#bullsht-what-does-it-really-do-to-my-files) +- [Bullsh\*t, what does it really do to my files](#bullsht-what-does-it-really-do-to-my-files) - [Supported Storages](#supported-storages) - [Supported Applications](#supported-applications) - [Can you support application X](#can-you-support-application-x) @@ -23,11 +23,11 @@ Keep your application settings in sync. Instructions for three common use cases are below. -* Scenario 1: is the quickest and easiest but gives you no control over - which applications are shared out for syncing -* Scenario 2: is also quick and easy and gives you control over which - applications are shared out for syncing -* Scenario 3: is for the many unfortunate souls that never bothered to sync +- **Scenario 1** is the quickest and easiest but gives you no control over + which applications are shared out for syncing. +- **Scenario 2** is also quick and easy and gives you control over which + applications are shared out for syncing. +- **Scenario 3** is for the many unfortunate souls that never bothered to sync the configurations files on the different machines they work on and are ready for Mackup to end their misery. @@ -654,4 +654,4 @@ remember, and it corresponds with the whole idea of Mackup: the simpler – the ## Where can I find more information -In the [doc](doc) directory. +I From 46c5fa279024d0f8bf52ba0bac12bc547e588872 Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Sun, 2 Sep 2018 16:06:17 -0400 Subject: [PATCH 10/11] add fixes/suggestions from maintainer on #1205 --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a4d4f6d01..76d7c30f3 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,17 @@ Keep your application settings in sync. Instructions for three common use cases are below. -- **Scenario 1** is the quickest and easiest but gives you no control over +- [**Scenario 1**](#Scenario-1) is the quickest and easiest but gives you no control over which applications are shared out for syncing. -- **Scenario 2** is also quick and easy and gives you control over which +- [**Scenario 2**](#Scenario-2) is also quick and easy and gives you control over which applications are shared out for syncing. -- **Scenario 3** is for the many unfortunate souls that never bothered to sync +- [**Scenario 3**](#Scenario-3) is for the many unfortunate souls that never bothered to sync the configurations files on the different machines they work on and are ready for Mackup to end their misery. -**Scenario 1:** You want to push **all** configuration settings from **all** +### Scenario 1 + +You want to push **all** configuration settings from **all** supported applications to get synced: If you have [Dropbox](https://www.dropbox.com) installed and want to use it to @@ -78,7 +80,9 @@ Done! You can find more detailed installation instructions in [INSTALL.md](INSTALL.md). -**Scenario 2:** You want to push configuration settings from **some** applications +### Scenario 2 + +You want to push configuration settings from **some** applications from one machine to others for syncing. Let's say you want to share just your bash configuration files with @@ -92,7 +96,7 @@ bash ``` Save the file and then run the same commands given in Scenario 1 -above to install andsync your apps. Done! +above to install and sync your apps. Done! As you get more comfortable with Mackup and want to add new applications to sync, simply add the name of the supported application @@ -101,7 +105,9 @@ You can also easily add unsupported applications as well. Learn more about modifying and customizing Mackup in [the documentation](doc/README.md). -**Scenario 3:** You want to merge the configuration settings of two or +### Scenario 3 + +You want to merge the configuration settings of two or more machines. For example, let's say your bash configuration on Machine A is different @@ -654,4 +660,4 @@ remember, and it corresponds with the whole idea of Mackup: the simpler – the ## Where can I find more information -I +In the [doc](doc) directory. From 5b4feaaa91a1575bc1fb39da18cc3d171f4259cd Mon Sep 17 00:00:00 2001 From: Steve Dondley Date: Sun, 2 Sep 2018 17:06:19 -0400 Subject: [PATCH 11/11] fix line length --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 76d7c30f3..d3b702cbd 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,13 @@ Keep your application settings in sync. Instructions for three common use cases are below. -- [**Scenario 1**](#Scenario-1) is the quickest and easiest but gives you no control over - which applications are shared out for syncing. -- [**Scenario 2**](#Scenario-2) is also quick and easy and gives you control over which - applications are shared out for syncing. -- [**Scenario 3**](#Scenario-3) is for the many unfortunate souls that never bothered to sync - the configurations files on the different machines they work on and are - ready for Mackup to end their misery. +- [**Scenario 1**](#Scenario-1) is the quickest and easiest but gives + you no control over which applications are shared out for syncing. +- [**Scenario 2**](#Scenario-2) is also quick and easy and gives + you control over which applications are shared out for syncing. +- [**Scenario 3**](#Scenario-3) is for the many unfortunate souls + that never bothered to sync the configurations files on the different + machines they work on and are ready for Mackup to end their misery. ### Scenario 1