Skip to content

docs: add comprehensive system requirements section #10060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

jadibdev
Copy link

This commit adds a detailed System Requirements section to README.md, including:

  • Supported operating systems with WSL2 note for Windows
  • Minimum hardware specifications
  • Required software versions
  • Additional prerequisites

These changes are needed because:

  1. The current README lacks clear system requirements information
  2. Users need to know if their system is capable of running AutoGPT before installation
  3. Having clear version requirements helps prevent compatibility issues
  4. WSL2 requirement for Windows users is crucial information that was missing

Changes 📝

  • Added new "System Requirements" section after the setup instructions
  • Organized requirements into clear categories:
    • Operating Systems
    • Hardware Requirements
    • Required Software Versions
    • Additional Prerequisites
  • Included specific version numbers for all required software
  • Added note about WSL2 requirement for Windows users

Fixes #10050

This commit adds a detailed System Requirements section to README.md,
including:
- Supported operating systems with WSL2 note for Windows
- Minimum hardware specifications
- Required software versions
- Additional prerequisites

Fixes Significant-Gravitas#10050
@jadibdev jadibdev requested a review from a team as a code owner May 29, 2025 16:35
@jadibdev jadibdev requested review from aarushik93 and majdyz and removed request for a team May 29, 2025 16:35
@github-project-automation github-project-automation bot moved this to 🆕 Needs initial review in AutoGPT development kanban May 29, 2025
@CLAassistant
Copy link

CLAassistant commented May 29, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

Copy link
Contributor

This PR targets the master branch but does not come from dev or a hotfix/* branch.

Automatically setting the base branch to dev.

@github-actions github-actions bot changed the base branch from master to dev May 29, 2025 16:35
@github-actions github-actions bot added platform/backend AutoGPT Platform - Back end size/m labels May 29, 2025
Copy link

deepsource-io bot commented May 29, 2025

Here's the code health analysis summary for commits 692f32a..e72b703. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource JavaScript LogoJavaScript✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link

netlify bot commented May 29, 2025

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit e72b703
🔍 Latest deploy log https://app.netlify.com/projects/auto-gpt-docs/deploys/68388ccfab05070008da3327

@majdyz majdyz requested review from Bentlybro and removed request for majdyz June 2, 2025 14:29
@Bentlybro
Copy link
Member

Hey thank you for this PR, it looks good but it seems this PR #10054 is set to merge which seems to do the same thing as this one!

Will close for now as to not have duplicated work but once again thank you for this PR!

@Bentlybro Bentlybro closed this Jun 2, 2025
@github-project-automation github-project-automation bot moved this from 🆕 Needs initial review to ✅ Done in AutoGPT development kanban Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add System Requirements Section to README.md
3 participants