Getting Started with ReadME Framework

Prerequisites

• Node.js 16.x or later
• npm 8.x or later
• Git (for GitHub installation method)

Installation Options

Option 1: Install via npm (Recommended)

1. Create your project directory:

   mkdir my-docs && cd my-docs
   npm init -y
   

Install ReadME Framework globally:

npm install -g readme-framework

Option 2: Install from GitHub

git clone https://github.com/ronyman-com/readME.git
cd readME
Install dependencies:
npm install

Initialize Your Documentation Create your first template (if needed):

readme init
Build your documentation:

readme build

Running the Development Server Start the local development server with hot-reloading:

readme start