-
Notifications
You must be signed in to change notification settings - Fork 932
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add different scenarios to the Quickstart section #1205
base: master
Are you sure you want to change the base?
Changes from 9 commits
054a1ec
dac75c3
a4348c3
410ab6d
2080c4f
f42f9ae
2e8ca9e
76dfbfe
164190f
46c5fa2
5b4feaa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
@@ -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 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** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you use headers to title each scenario? |
||
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. | ||
|
||
|
@@ -63,7 +76,51 @@ 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 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 | ||
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! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. andsync |
||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you specify how? ( There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please clarify this? I'm not sure what you are looking for here. Other changes were made. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just give a hint for your readers to know how they can know what to add there, telling them to run There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh OK. Sure, will take care of this when I get a chance. |
||
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 | ||
|
||
|
@@ -597,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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Typo? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be cool to link to each scenario