fr-scrabble-finder

What is this project ?

This project helps to find the word that gives the most points to scrabble (French version) based on a list of given letters.

Run the project

Follow these steps to run the Scrabble Solver:

1. Go to the repository homepage.

2. Click on the green "<> Code" button, go to the "Local" tab and download the ZIP.

3. Unpack the zip file.

4. Install Python if not done by going to the official website and following the instructions for your operating system.

5. Open a terminal or a command prompt and go to the project directory. For example:

cd Downloads/fr-scrabble-finder-main/

6. Navigate with the cd command to the "scr" folder:

cd src/

7. Run the main.py file by doing:

python3 main.py

You want to contribute ?

If you want to contribute to this project, you are welcome! For this, there are a few steps:

1. Create a fork of this project in your GitHub account.

2. Clone this fork on your machine with:

   # make sure that git is installed before doing this
   git clone https://github.com/your-username/fr-scrabble-finder.git

3. Create a new branch that describes what you want to do by entering:

   git checkout -b my-branch

4. Make your changes.

Important: add your GitHub username to the CONTRIBUTORS.md file following the syntax of the creator.

5. Add the files you have modified:

   git add .

6. Make a commit where you say everything you’ve done:

   git commit -m "change... and add..."

Please start your commit with a lowercase letter to ensure continuity of commit history

7. Push your changes to GitHub:

   git push -u origin my-branch

8. Make a pull request by going to the project fork page and clicking on "Contribute > Open pull request". A window will open, and you will be able to explain in more detail all the changes you have made.

9. Validate and then wait for validation... 😊

💡 You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star!

License

This project is under a MIT license.