Skip to content

Commit

Permalink
Added all the .md files V.015/07/2023
Browse files Browse the repository at this point in the history
  • Loading branch information
Clicxl committed Jul 15, 2023
1 parent 39f2e2c commit 2cf26a5
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 0 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to GeoBLITZ

๐ŸŽ‰ Thank you for considering contributing to GeoBLITZ! ๐ŸŽ‰

We welcome contributions from the community and appreciate any help in making GeoBLITZ even better.

## How to Contribute

To contribute to GeoBLITZ, please follow these steps:

1. Fork the repository to your own GitHub account.
2. Create a new branch with a descriptive name for your feature or bug fix.
3. Make the necessary changes in your branch.
4. Test your changes to ensure they work correctly.
5. Commit your changes and push them to your forked repository.
6. Submit a pull request from your branch to the `main` branch of the original repository.
7. Provide a clear and concise description of your changes in the pull request, including any relevant information or context.

## Code Style and Guidelines

- Follow the existing code style and naming conventions.
- Write clear, concise, and self-documenting code.
- Document your code using comments where necessary.
- Ensure your code is well-tested and doesn't introduce any regressions.

## Issue Reporting

If you encounter any bugs, issues, or have feature requests, please open an issue on the GitHub repository. Provide a clear and detailed description of the problem or request, along with any relevant information to reproduce the issue.

## Licensing

By contributing to GeoBLITZ, you agree that your contributions will be licensed under the [CC BY-NC-ND 4.0 License](LICENSE.md). Please make sure you understand and agree to this before submitting a pull request.

Thank you for your contribution and support in making GeoBLITZ a great game! ๐ŸŒ๐ŸŽฎ
17 changes: 17 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# GeoBLITZ License

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0) License.

You are free to:

- Share: Copy and redistribute the material in any medium or format.
- Adapt: Modify the material for personal or educational purposes.

Under the following terms:

- Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
- NonCommercial: You may not use the material for commercial purposes.
- NoDerivatives: If you remix, transform, or build upon the material, you may not distribute the modified material.

Read the full license text [here](https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode).

49 changes: 49 additions & 0 deletions ReadME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# GeoBLITZ ๐ŸŒ๐Ÿ”

Welcome to GeoBLITZ, a thrilling geography challenge game where you can test your knowledge and guess countries from their outlines!

**Note: GeoBLITZ is a work in progress and is not available for download at this time. This repository serves as a code storage and source for the game.**

***
## Prerequisites
To run GeoBLITZ, you will need the following:

- [Python 3.6](https://www.python.org/downloads/) or higher
- [Pygame 2](https://pygame.org) or higher

***
## Setup And Running
## Installation
1. Install Python by following the instructions on the official Python website.
2. Install Pygame by running the following command: ```Pip install pygame```
***
### Manual installation (recommended)
Your will need [**Python**](https://www.python.org/) and [**Pygame**](https://www.pygame.org/news) to be able to play the game.

##### Stable releases
The latest releases of Clicxl are published to our GitHub release pages. Releases are considered by our team to be **suitable for general use**, but they are not guaranteed to be free of bugs and other issues.

Usually, releases will be made available on GitHub slightly sooner than other locations.

##### Bleeding-edge builds (unstable)
If you are a player who is looking to get your hands on the latest**bleeding-edge changes for testing**, then you might consider to look into our snapshots version.

Bleeding edge builds will often include unfinished code that hasn't been extensively tested. That code may introduce incomplete features, bugs, crashes, and all other kinds of weird issues. You **should not use these bleeding edge builds** unless you know what you are doing and are comfortable with software debugging. If you report issues using these builds, we will expect that this is the case.
***
#### Reporting Issues
You can report bugs and crashes by opening an issue on our [issue tracker](https://github.com/Clicxl/GeoBLITZ/issues). Before opening a new issue, use the search tool to make sure that your issue has not already been reported and ensure that you have completely filled out the issue template. Issues that are duplicates or do not contain the necessary information to triage and debug may be closed.

Please note that while the issue tracker is open to feature requests, development is primarily focused on improving hardware compatibility, performance, and finishing any unimplemented features necessary for parity with the vanilla renderer.

***
## Contributing
We welcome contributions to GeoBLITZ! If you would like to contribute, please follow the guidelines outlined in [CONTRIBUTING](CONTRIBUTING.md).

***
## License
This project is licensed under the [MIT License](LICENSE.md).
***
## Acknowledgments
We would like to thank the Pygame community, my Friend and contributors for their invaluable support and the amazing open-source libraries that make GeoBLITZ possible.


0 comments on commit 2cf26a5

Please sign in to comment.