From 90da2571dbf35b9a89721598aac21c84df5cfd29 Mon Sep 17 00:00:00 2001 From: Asankhaya Sharma Date: Sat, 13 Sep 2025 08:07:44 +0800 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 81d47b47..75ee8a1b 100644 --- a/README.md +++ b/README.md @@ -80,20 +80,19 @@ Get from zero to evolving code in **30 seconds**: # Install OpenEvolve pip install openevolve -# Set your LLM API key (works with any OpenAI-compatible provider) -export OPENAI_API_KEY="your-api-key" +# The example uses Google Gemini by default (free tier available) +# Get your API key from: https://aistudio.google.com/apikey +export OPENAI_API_KEY="your-gemini-api-key" # Yes, use OPENAI_API_KEY env var # Run your first evolution! -python -c " -from openevolve import run_evolution -result = run_evolution( - 'examples/function_minimization/initial_program.py', - 'examples/function_minimization/evaluator.py' -) -print(f'Best score: {result.best_score:.4f}') -" +python openevolve-run.py examples/function_minimization/initial_program.py \ + examples/function_minimization/evaluator.py \ + --config examples/function_minimization/config.yaml \ + --iterations 50 ``` +**Note:** The example config uses Gemini by default, but you can use any OpenAI-compatible provider by modifying the `config.yaml`. See the [configs](configs/) for full configuration options. + ### 📚 **Library Usage** OpenEvolve can be used as a library without any external files: