mirror of
https://github.com/danielmiessler/fabric
synced 2024-11-08 07:11:06 +00:00
pushes readme updates
This commit is contained in:
parent
14d4f8c169
commit
b00d3d286d
37
README.md
37
README.md
@ -31,22 +31,22 @@
|
||||
- [Too many prompts](#too-many-prompts)
|
||||
- [The Fabric approach to prompting](#our-approach-to-prompting)
|
||||
- [Quickstart](#quickstart)
|
||||
- [1. Just use the Patterns (Prompts)](#just-use-the-patterns)
|
||||
- [2. Create your own Fabric Mill (Server)](#create-your-own-fabric-mill)
|
||||
- [Setting up the fabric client](#setting-up-the-fabric-client)
|
||||
- [Using the fabric client](#using-the-fabric-client)
|
||||
- [Just use the Patterns](#just-use-the-patterns)
|
||||
- [Create your own Fabric Mill](#create-your-own-fabric-mill)
|
||||
- [Structure](#structure)
|
||||
- [Components](#components)
|
||||
- [CLI-native](#cli-native)
|
||||
- [Directly calling Patterns](#directly-calling-patterns)
|
||||
- [Examples](#examples)
|
||||
- [Meta](#meta)
|
||||
- [Primary contributors](#primary-contributors)
|
||||
|
||||
<br />
|
||||
|
||||
```bash
|
||||
# A quick demonstration of writing an essay with Fabric
|
||||
```
|
||||
|
||||
|
||||
|
||||
https://github.com/danielmiessler/fabric/assets/50654/09c11764-e6ba-4709-952d-450d70d76ac9
|
||||
|
||||
## What and why
|
||||
@ -242,6 +242,31 @@ But we go beyond just providing Patterns. We provide code for you to build your
|
||||
|
||||
To get started, head over to the [`/server/`](https://github.com/danielmiessler/fabric/tree/main/server) directory and set up your own Fabric Mill with your own Patterns running! You can then use the [`/client/standalone_client_examples`](https://github.com/danielmiessler/fabric/tree/main/client/standalone_client_examples) to connect to it.
|
||||
|
||||
#### Installing the server
|
||||
|
||||
Similarly to what you did for installing the CLI, now access the `/server` folder and install the dependencies with poetry, then add the alias to the `fabric-server` binary to bash profile and call `fabric-server`:
|
||||
```bash
|
||||
# access the server directory
|
||||
cd server
|
||||
|
||||
# install dependencies
|
||||
poetry install
|
||||
|
||||
# activate virtual environment
|
||||
poetry shell
|
||||
|
||||
# determine the path to the fabric-server binary
|
||||
which fabric-api
|
||||
# determine the path to the fabric-webui binary
|
||||
which fabric-webui
|
||||
|
||||
# create an alias to them
|
||||
echo 'alias fabric-server="/the/path/to/fabric/server/fabric-api"' >> ~/.bashrc
|
||||
echo 'alias fabric-webui="/the/path/to/fabric/server/fabric-webui"' >> ~/.bashrc
|
||||
```
|
||||
|
||||
PS: `fabric-api` and `fabric-webui` need to be run in dictinct terminal windows.
|
||||
|
||||
## Structure
|
||||
|
||||
Fabric is themed off of, well… _fabric_—as in…woven materials. So, think blankets, quilts, patterns, etc. Here's the concept and structure:
|
||||
|
Loading…
Reference in New Issue
Block a user