liberu-genealogy / php-dna

DNA processing and manipulating for PHP 8.3
https://www.liberu.co.uk
MIT License
31 stars 23 forks source link

Sweep: update readme.md #121

Closed curtisdelicata closed 8 months ago

curtisdelicata commented 8 months ago

Details

Update README.md on how to call src/MatchKits.php from the command line

Checklist - [X] Modify `README.md` βœ“ https://github.com/liberu-genealogy/php-dna/commit/d476315c92672dd8335bbcab5eb9848ab3f23989 [Edit](https://github.com/liberu-genealogy/php-dna/edit/sweep/update_readmemd/README.md#L1-L1) - [X] Running GitHub Actions for `README.md` βœ“ [Edit](https://github.com/liberu-genealogy/php-dna/edit/sweep/update_readmemd/README.md#L1-L1)
sweep-ai[bot] commented 8 months ago

πŸš€ Here's the PR! #122

See Sweep's progress at the progress dashboard!
πŸ’Ž Sweep Pro: I'm using GPT-4. You have unlimited GPT-4 tickets. (tracking ID: ce80c1db1d)

[!TIP] I'll email you at genealogysoftwareuk@gmail.com when I complete this pull request!


Actions (click)

GitHub Actionsβœ“

Here are the GitHub Actions logs prior to making any changes:

Sandbox logs for ff8d23a
Checking README.md for syntax errors... βœ… README.md has no syntax errors! 1/1 βœ“
Checking README.md for syntax errors...
βœ… README.md has no syntax errors!

Sandbox passed on the latest main, so sandbox checks will be enabled for this issue.


Step 1: πŸ”Ž Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I think are relevant in decreasing order of relevance (click to expand). If some file is missing from here, you can mention the path in the ticket description. https://github.com/liberu-genealogy/php-dna/blob/ff8d23a9e43377911c05cd64077319b9c8c53e7e/src/MatchKits.php#L1-L45

Step 2: ⌨️ Coding

--- 
+++ 
@@ -1,4 +1,16 @@
 # php-dna
+
+## Running MatchKits from the Command Line
+
+To run the MatchKits script from the command line, navigate to the root directory of the php-dna project.
+
+Ensure you have PHP installed on your system. You can check this by running `php -v` in your command line. If PHP is not installed, please install it from the official PHP website.
+
+Execute the script by running the following command: `php src/MatchKits.php`.
+
+The script will prompt you to enter the file paths for Kit 1 and Kit 2. Please enter the full path for each file when prompted.
+
+After entering the file paths, the script will process the data and generate a matched data visualization. The output file named 'matched_data.png' will be saved in the root directory.

 ## Requirements

Ran GitHub Actions for d476315c92672dd8335bbcab5eb9848ab3f23989:


Step 3: πŸ” Code Review

I have finished reviewing the code for completeness. I did not find errors for sweep/update_readmemd.


πŸŽ‰ Latest improvements to Sweep:
  • New dashboard launched for real-time tracking of Sweep issues, covering all stages from search to coding.
  • Integration of OpenAI's latest Assistant API for more efficient and reliable code planning and editing, improving speed by 3x.
  • Use the GitHub issues extension for creating Sweep issues directly from your editor.

πŸ’‘ To recreate the pull request edit the issue title or description. To tweak the pull request, leave a comment on the pull request.Something wrong? Let us know.

This is an automated message generated by Sweep AI.