Skip to content
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

Update README.md #70

Merged
merged 6 commits into from
Sep 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 71 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,94 @@
<a href="https://github.com/8enrich/Letris/actions"><img src="https://img.shields.io/github/actions/workflow/status/8enrich/Letris/cmake-multi-platform.yml" alt="Build Status" /></a>
</p>

## Description
# Description

Letris is an open-source Tetris clone developed in C++ using [raylib](https://github.com/raysan5/raylib) and [nlohmann/json](https://github.com/nlohmann/json). It features a simple and minimalistic design, aiming to capture the essence of the classic game with modern touches.

## Features
# Features

- **Minimalistic Design**: A clean and straightforward user interface.
- **Cross-Platform**: Compatible with multiple operating systems.
- **Customizable Settings**: Adjust game settings to your preference.
- **High Score Tracking**: Keep track of your best scores.

## Installation

in progress
# Installation

## Windows
To download the latest Windows version, click [here](https://github.com/8enrich/Letris/releases).

### Running the game from the ZIP
1. Download Letris-Windows-amd64.zip from the latest release and unzip it.
2. Run the executable (letris.exe) inside the folder.

### Running the game from the Installer
1. Download the installer (letris-amd64-Windows.exe).
2. Follow the on-screen instructions to install the game.

## Linux
Currently, there is no pre-built Linux binary available. However, you can compile the game from source.

### Compiling the Game
#### Build tools

You will need to install some build tools, such as GCC, Make, Git and CMake

For Ubuntu/Debian, you can run:
```bash
sudo apt install build-essential git cmake
```
For Fedora you can run
```
sudo dnf install -y gcc gcc-c++ make git cmake
```
For Arch Linux you can run
```bash
sudo pacman -S git base-devel cmake
```
#### Required libraries

[Some libraries are required by raylib](https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux) for displaying graphics and audio correctly (ALSA, OpenGL/Mesa and X11)

For Ubuntu/Debian you can run:

```bash
sudo apt install libasound2-dev libx11-dev libxrandr-dev libxi-dev libgl1-mesa-dev libglu1-mesa-dev libxcursor-dev libxinerama-dev libwayland-dev libxkbcommon-dev
```
For Fedora you can run:

```bash
sudo dnf install alsa-lib-devel mesa-libGL-devel libX11-devel libXrandr-devel libXi-devel libXcursor-devel libXinerama-devel libatomic
```
For Arch Linux you can run:

```bash
sudo pacman -S alsa-lib mesa libx11 libxrandr libxi libxcursor libxinerama
```

Once the dependencies are installed, follow these steps to build the game:

```bash
git clone https://github.com/8enrich/Letris.git # Clone the repository
cd Letris # Enter the repository
mkdir build && cd build # Create and navigate to the build directory
cmake -S .. # Configure the project with CMake
make # Build the game binary
./letris # Run the game
```

Feel free to customize further, but this should make it more structured and clear!


## Usage
# Usage

in progress

## License
# License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact
# Contact

For any inquiries or support, please open an issue on the [GitHub repository](https://github.com/8enrich/Letris).
.