Skip to content

Commit

Permalink
feat(docs/getting-started): Explain importance of well defined behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
Estrada Irribarra, Rodrigo Andres committed Oct 21, 2024
1 parent 4ab88d5 commit 2f3339f
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,6 @@ echo "your-openai-api-key" > ~/.storycraftr/openai_api_key.txt

Once installed and the API key is set, you can run the tool using the command `storycraftr`.

## Step 2: Initialize Your Book Project

In Sanderson's writing methodology, having a clear starting point and preparation is essential for consistency and flow. Let's create our science fiction novel titled **La Purga de los Dioses** by **Rodrigo Estrada**.

1. **Create the project**:

```bash
mkdir la-purga-de-los-dioses
cd la-purga-de-los-dioses
```

## Step 2: Create the Behavior File

The **behavior file** is a crucial component that guides the AI’s **writing process**. It represents the **vision** of the writer and defines the behavior the AI should follow when generating the story. This file goes beyond plot or character details—it sets the tone, style, and thematic focus of the book and is the foundation for how the AI approaches the entire writing process.
Expand Down Expand Up @@ -89,6 +78,7 @@ The behavior file serves as the **creative guide** for your story. It helps the

```bash
storycraftr init "The Purge of the Gods" --primary-language "en" --alternate-languages "es" --author "Rodrigo Estrada" --genre "science fiction" --behavior "behavior.txt" --reference-author "Brandon Sanderson"
cd "The Purge of the Gods"
```

> **Note:** In the following commands, any modified files are always backed up with a _.back_ extension.
Expand Down

0 comments on commit 2f3339f

Please sign in to comment.