Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexDeFoc committed Sep 8, 2024
1 parent d328730 commit 6501ff7
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Synchronize your minecraft worlds with your friends with ease

<br>

## Instalation
### Guide for Windows:
1. Go to the [Releases](https://github.com/AlexDeFoc/MineSync/releases/latest)
2. Download the executable for your cpu architecture. Most probably it's 64 or 32 bit. It will look like this: _win_cpu_???.exe. If you don't understand the names of the architectures provided check this footnote.[^1]
[^1]: amd64 = 64 bit cpu, i386 = 32 bit cpu
3. Double-Click it and follow the steps of the installer.
4. Done!
### Guide for Linux/MacOS:
1. Go to the [Releases](https://github.com/AlexDeFoc/MineSync/releases/latest)
2. Download the zip file. It has a .zip extension.
3. Extract the files from the archive into a folder where you want the app to be.

<br>

## Configuration
- Worlds folder
- Log level: by default it's "Info"
##### Log Levels:
- Info: Gives you normal information in your console
- Debug: Gives you a bit more data, more for me the dev but you can try it and have fun

<br>

## Problems
If you encounter any issues with the app report it here, please also provide a screenshot/video, here: [Issues](https://github.com/AlexDeFoc/MineSync/issues) and use the appropriate flair.

0 comments on commit 6501ff7

Please sign in to comment.