From 4cdf62723217b45dd2a394fcfe8d494109e741d0 Mon Sep 17 00:00:00 2001 From: ianarawjo Date: Mon, 8 May 2023 11:40:03 -0400 Subject: [PATCH 1/2] Update CONTRIBUTOR_GUIDE.md --- CONTRIBUTOR_GUIDE.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTOR_GUIDE.md b/CONTRIBUTOR_GUIDE.md index 4384f25..b3d8109 100644 --- a/CONTRIBUTOR_GUIDE.md +++ b/CONTRIBUTOR_GUIDE.md @@ -60,3 +60,8 @@ This script spins up two servers, the main one on port 8000 and a SocketIO serve If you built the React app statically, go to `localhost:8000` in a web browser to view the app. If you served the React app with hot reloading with `npm run start`, go to the server address you ran it on (usually `localhost:3000`). + + +## Contributing to ChainForge + +If you have access to the main repository, we request that you add a branch `dev/` and develop changes from there. When you are ready to push changes, say to addres an open Issue, make a Pull Request on the `main` repository and assign the main developer (Ian Arawjo) to it. From 9f228a5789d2e111f997f077d2afdc4b65483dc3 Mon Sep 17 00:00:00 2001 From: ianarawjo Date: Mon, 8 May 2023 11:43:03 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 33 +++++++++++++-------------------- 1 file changed, 13 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a71e51b..6580834 100644 --- a/README.md +++ b/README.md @@ -19,30 +19,23 @@ Taken together, these three features let you easily: # Installation -To install, use `pip`. From the command line: +To get started, currently see the `CONTRIBUTOR_GUIDE.md`. Below are the planned installation steps (which are not yet active): -``` -pip install chainforge -``` - -[TODO: Upload CF to PyPI] -[TODO: Create a command-line alias (?) so you can run `chainforge serve ` and spin up both React and the Python backend automatically.] - -To run simply, type: - -``` -chainforge serve -``` - -This spins up two local servers: a React server through npm, and a Python backend, powered by Flask. For more options, such as port numbers, type `chainforge --help`. - -### Sharing prompt chains - -All ChainForge node graphs are importable/exportable as JSON specs. You can freely share prompt chains you develop (alongside any custom analysis code), whether to the public or within your organization. +> +> To install, use `pip`. From the command line: +> +> ``` +> pip install chainforge +> ``` +> To run, type: +> ``` +> chainforge serve +> ``` +> This spins up two local servers: a React server through npm, and a Python backend, powered by Flask. For more options, such as port numbers, type `chainforge --help`. ## Example: Test LLM robustness to prompt injection -... +> ... # Development