diff options
| author | Nate Sesti <sestinj@gmail.com> | 2023-05-28 21:52:11 -0400 |
|---|---|---|
| committer | Nate Sesti <sestinj@gmail.com> | 2023-05-28 21:52:11 -0400 |
| commit | b2fbaa0d071aa741c04cc5c38d3cd4ac798f3ead (patch) | |
| tree | 723b3af34192a844d4f1d7db494037a78a1d03d2 | |
| parent | 1f7486bd1cc889c8eacbc30c42793d80b04b48f3 (diff) | |
| download | sncontinue-b2fbaa0d071aa741c04cc5c38d3cd4ac798f3ead.tar.gz sncontinue-b2fbaa0d071aa741c04cc5c38d3cd4ac798f3ead.tar.bz2 sncontinue-b2fbaa0d071aa741c04cc5c38d3cd4ac798f3ead.zip | |
continuedev README improvements
| -rw-r--r-- | continuedev/README.md | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/continuedev/README.md b/continuedev/README.md index 5658e8de..a1ddb084 100644 --- a/continuedev/README.md +++ b/continuedev/README.md @@ -1,27 +1,23 @@ -# Continue +# Continue PyPI Package Continue is a Python library for automating repetitive sequences of software development tasks using language models. Using our VS Code extension, you can build, run, and refine these recipes as they natively interact with your codebase. Download on [our GitHub](https://github.com/continuedev/continue). -## Steps to start +## Continue Server -- `cd continue/continue` +The Continue server acts as a bridge between the Continue React app and your IDE, running your recipes and acting on the codebase. Start it by running the following commands: + +- `cd continuedev` - Make sure packages are installed with `poetry install` - `poetry shell` - `cd ..` -- `python3 -m continuedev.src.continuedev` - -## Steps to generate JSON Schema - -Same up until last step and then `python3 -m continuedev.src.scripts.gen_json_schema`. - -## Start the server +- `python3 -m continuedev.src.continuedev.server.main` -Same steps, then `uvicorn continue.src.server.main:app --reload`. +## Scripts -## To build +`poetry run typegen` to generate JSONSchema .json files from the Pydantic types defined in the `models` directory. -Run `poetry build` and it will output wheel and tarball files in `./dist`. +`poetry build` will output wheel and tarball files in `./dist`. ## Writing Steps -See the `src/continuedev/libs/steps` folder for examples of writing a Continue step. +See the `src/continuedev/libs/steps` folder for examples of writing a Continue step. See our documentation for tutorials. |