1. Rewritten README
The rewritten README.md is available here: Github Link🔗.
My contributions mainly include:
Rewrote, reformated, and reorganized sections to improve the overall structure and clarity of the README.
Added step-by-step instructions in the Quick Start section to make it more beginner-friendly.
Fixed a broken shortcode example (
x) by replacing it with the correcttweetshortcode.
For full details, see the pull request on GitHub.
2. README Comparison
The original README had a flat structure with minimal sectioning. In the improved version, the content is logically organized, with clearly separated sections for setup, content management, and deployment. This makes it easier for beginners to follow.
| Aspect | Before | After (Improved) |
|---|---|---|
Requirements | Brief mention of Hugo version only | Expanded with version check command and install link |
Getting Started | Basic setup steps without much explanation or trouble-shootings | A step-by-step Quick Start section from site creation to local preview |
Content Management | Only a few reference links | New section on editing site content |
Deployment | Basic Netlify usage | Clear options for Netlify (template vs manual setup) and static hosting |
Tone | Technical and brief, assumes prior knowledge | Beginner-focused, with explanatory details |
See below for screenshots of the original and improved README. The updated version is broken into sections for better usability:
2.1. Before
2.2. After
3. Shortcode Fix
Fixed a non-functional shortcode in the example content to avoid build errors, and documented known issues of the new solution.
