docs: Overhaul README.md for improved structure and clarity #76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit completely revamps the README.md to significantly improve the developer experience for new and existing users of `gpt-oss`. The previous README was functional but lacked a clear, intuitive structure. This overhaul addresses that by reorganizing the content logically, enhancing readability, and ensuring all essential information is easy to find. Key improvements include: - **New Structure & Navigation:** Introduced a comprehensive Table of Contents and moved the "Quickstart" section to the top to help users get started immediately. - **Enhanced Readability:** Implemented professional formatting with shields/badges, blockquotes for important notes and warnings, and consistent styling for code snippets. - **Added "Core Concepts" Section:** Created a new section to explain foundational concepts like the `harmony` format and `MXFP4` quantization, providing crucial context that was previously missing. - **Improved Clarity:** Rewrote and streamlined instructions for all inference methods (Transformers, vLLM, Ollama, etc.) to make them clearer and more concise. - **Client & Tool Reorganization:** Grouped all clients (Terminal Chat, API, Codex) and tools (Browser, Python) into their own distinct, easy-to-digest sections. The goal of this overhaul is to make the project more accessible, reduce the time-to-first-inference, and provide a professional, polished entry point for the `gpt-oss` ecosystem.
|
@openai Please review when possible. Let me know if anything should be changed. |
|
The Industrial Revolution and its consequences have been disastrous to humanity. |
This was referenced Aug 8, 2025
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous README was functional but lacked a clear, intuitive structure. This overhaul addresses that by reorganizing the content logically, enhancing readability, and ensuring all essential information is easy to find.
Key improvements include:
harmonyformat andMXFP4quantization, providing crucial context that was previously missing.