Skip to content

Commit

Permalink
Merge pull request #70 from polywrap/requirements-section
Browse files Browse the repository at this point in the history
chore: added requirements section to root README
  • Loading branch information
dOrgJelli authored Aug 15, 2023
2 parents b606ec9 + b57e727 commit 73594b0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 22 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ Join the [discord](https://discord.polywrap.io) for help using PolyGPT, or integ

# Getting Started

## Pre-Requisites
Please install the following:
* [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [nodejs & npm](https://nodejs.org/en/download/package-manager#alpine-linux)
* [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
* [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)

## Setup

1. Clone the repository
Expand Down
24 changes: 2 additions & 22 deletions docs/windows-wsl2-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,6 @@ https://www.kali.org/docs/general-use/metapackages/
Launch Kali in terminal:
`kali`

Install git & yarn:
* [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [nodejs & npm](https://nodejs.org/en/download/package-manager#alpine-linux)
* [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
* [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
## Follow: "Getting Started"

Clone PolyGPT:
`git clone https://github.com/polywrap/PolyGPT.git`

Copy the .env.template file and rename it to .env:
`cp .env.template .env`

Find the line that says OPENAI_API_KEY=, and add your unique OpenAI API Key:
`OPENAI_API_KEY=sk-...`

Use the correct version of Node.JS:
`nvm install && nvm use`

Install npm packages:
`yarn`

Start the agent:
`yarn start`
Follow the "Getting Started" steps detailed in the root [README](../README.md).

0 comments on commit 73594b0

Please sign in to comment.