From f9294e54334b93a02b1863af1b150fe1228f9db2 Mon Sep 17 00:00:00 2001 From: John <75003086+ZYJLiu@users.noreply.github.com> Date: Mon, 21 Oct 2024 11:12:12 -0500 Subject: [PATCH] update readme (#580) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 3ec8a498f..14bb5d91a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,22 @@ These markdown based content posts are gathered from contributors from around the Solana ecosystem and displayed on [solana.com/developers](https://solana.com/developers) for all to learn from. +## Setup Instructions + +This repository contains only the markdown files for content. The content is +rendered through a separate UI repository. + +1. Clone this repository (developer-content) +2. Clone the UI repository: + [solana-com](https://github.com/solana-foundation/solana-com) +3. Run both repositories locally to view the rendered content + +In the solana-com repo, you must add the following `.env` variable: + +``` +NEXT_PUBLIC_DEVELOPER_CONTENT_API_URL="http://localhost:3001" +``` + ## Structure There are a few primary types of Solana Developer content within this repo: