From 5a391f94d0fb7c6b85b99fa2fdca2de5828cfd76 Mon Sep 17 00:00:00 2001 From: vr-varad <114755221+vr-varad@users.noreply.github.com> Date: Thu, 8 Feb 2024 14:59:40 +0530 Subject: [PATCH] Updated Readme with section How to contribute (#12) --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index e758f8d0..4a644178 100644 --- a/README.md +++ b/README.md @@ -60,3 +60,36 @@ For more information about other install methodologies and platforms or Docker, ## Examples You can find a complete [list of examples in the documentation](/docs/docs.md#_43-examples). If you are interested in submitting new examples, please [contact us in our chats](/docs/community.md#community). + +## How to Contribute + +### Starting Stack + +- Clone the repository: + + ```bash + git clone https://github.com/metacall/landing-page.git + cd landing-page + ``` + +### How to Run + +1. Install `docsify-cli` globally: + + ```bash + npm install docsify-cli -g + ``` + +2. Initialize docsify in the "./docs" directory: + + ```bash + docsify init ./docs + ``` + +3. Run the local server with docsify: + + ```bash + docsify serve docs + ``` + + You can now preview your site in your browser by navigating to [http://localhost:3000](http://localhost:3000). \ No newline at end of file