updated README

This commit is contained in:
Johannes Schmelz 2024-05-12 15:18:37 +02:00
parent 0911f7b2b9
commit 020716053b

View File

@ -1,18 +1,18 @@
## Getting Started
# MAU-MAU
Welcome to the VS Code Java world. Here is a guideline to help you get started to write Java code in Visual Studio Code.
This Java project implements the classic card game Mau-Mau. Mau-Mau is a popular shedding-type card game for 2 or more players, played with a standard deck of cards.
## Folder Structure
The workspace contains two folders by default, where:
The workspace contains three folders by default, where:
- `src`: the folder to maintain sources
- `lib`: the folder to maintain dependencies
- `test`: the folder to maintain tests
Meanwhile, the compiled output files will be generated in the `bin` folder by default.
> If you want to customize the folder structure, open `.vscode/settings.json` and update the related settings there.
## Dependency Management
## Contributing
The `JAVA PROJECTS` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-dependency#manage-dependencies).
Contributions to this project are welcome! If you'd like to contribute, please fork the repository, make your changes, and submit a pull request.