Skip to content

Commit

Permalink
Merge pull request #3 from Pilaton/dev
Browse files Browse the repository at this point in the history
fix(docs): Correcting the readme file
  • Loading branch information
Pilaton authored Dec 7, 2021
2 parents 957d61d + 4da05d4 commit fdf8ec3
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div style="text-align: center;">
<div align="center">
<a href="https://github.com/Pilaton/MacSync">
<img alt="MacSync" src="./doc/images/MacSync_logo.svg" alt="MacSync - Easy sync for Mac OS" style="border-radius: 50%;width: 400px;">
<img src="./doc/images/MacSync_logo.svg" alt="MacSync - Easy sync for Mac OS" width="400">
</a>
<h1>🍁🔆 MacSync</h1>
<div>Easy sync for macOS. Dotfiles, folders, configurations, etc.</div>
Expand Down Expand Up @@ -65,7 +65,9 @@ zsh ./bin/install.zsh

After launch, you will be offered options to choose from (below is a diagram).

![MacSync usage](doc/images/MacSync-usage.svg)
<div align="center">
<img alt="MacSync usage" src="./doc/images/MacSync-usage.svg" width="650">
</div>

Let's go over some points.

Expand All @@ -92,7 +94,9 @@ This command simply connects your device to the sync folder.

After you specify the path to the sync folder and the list of synced files in `config/config.cfg`, and run the application, you get the following directory structure:

![MacSync usage](doc/images/MacSync-folder-structure.svg)
<div align="center">
<img alt="MacSync folder structure" src="./doc/images/MacSync-folder-structure.svg" width="650">
</div>

I will also leave the directory scheme in its usual form. 😉

Expand Down
2 changes: 1 addition & 1 deletion doc/images/MacSync-folder-structure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/images/MacSync-usage.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 4 additions & 8 deletions doc/images/MacSync_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fdf8ec3

Please sign in to comment.