ayrisdev/crawl4ai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: simplify installation instructions

Browse Source 
- Add crawl4ai-doctor command to verify installation
- Update browser installation instructions in README and docs
- Move optional features to documentation
- Add manual browser installation steps as fallback
- Update getting-started guide with verification step
This commit is contained in:
UncleCode
2025-01-01 16:54:03 +08:00
parent dc6a24618e
commit 4a4f613238
2 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -39,13 +39,17 @@ Crawl4AI is the #1 trending GitHub repository, actively maintained by a vibrant
```bash ```bash
# Install the package # Install the package
pip install crawl4ai pip install crawl4ai
# Run post-installation setup
crawl4ai-setup crawl4ai-setup
# Install Playwright with system dependencies (recommended) # Verify your installation
playwright install --with-deps crawl4ai-doctor
```
# Or install specific browsers: If you encounter any browser-related issues, you can install them manually:
playwright install --with-deps chrome # Recommended for Colab/Linux ```bash
python -m playwright install --with-deps chrome chromium
``` ```
2. Run a simple web crawl: 2. Run a simple web crawl:

9
docs/md_v3/tutorials/getting-started.md
View File

@@ -31,7 +31,14 @@ By the end of this guide, you’ll have installed Crawl4AI, performed a basic cr
```bash ```bash
pip install crawl4ai pip install crawl4ai
crawl4ai-setup crawl4ai-setup
playwright install --with-deps
# Verify your installation
crawl4ai-doctor
```
If you encounter any browser-related issues, you can install them manually:
```bash
python -m playwright install --with-deps chrome chromium
``` ```
- **`crawl4ai-setup`** installs and configures Playwright (Chromium by default). - **`crawl4ai-setup`** installs and configures Playwright (Chromium by default).