-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Estrada Irribarra, Rodrigo Andres
committed
Oct 20, 2024
1 parent
32a25e6
commit 853fc01
Showing
4 changed files
with
93 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,12 +9,14 @@ Welcome to [**StoryCraftr**](https://storycraftr.app), the open-source project d | |
|
||
You can find the release notes for version `v0.5.0-alpha1` [here](https://github.com/raestrada/storycraftr/releases/tag/v0.5.0-alpha1). | ||
|
||
## Installation | ||
## Step 1: Install StoryCraftr | ||
|
||
You can install the current version of **StoryCraftr** via `pipx` using the following command: | ||
First, install **StoryCraftr** using [pipx](https://pypa.github.io/pipx/), a tool to help you install and run Python applications in isolated environments. It works on most platforms, including macOS, Linux, and Windows. Using `pipx` ensures that **StoryCraftr** runs in its own virtual environment, keeping your system's Python installation clean. | ||
|
||
To install **StoryCraftr**, run the following command: | ||
|
||
```bash | ||
pipx install git+https://github.com/raestrada/[email protected].0-alpha1 | ||
pipx install git+https://github.com/raestrada/[email protected].1-alpha1 | ||
``` | ||
|
||
### Important: Before using StoryCraftr, make sure to set your OpenAI API key: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,7 +11,7 @@ First, install **StoryCraftr** using [pipx](https://pypa.github.io/pipx/), a too | |
To install **StoryCraftr**, run the following command: | ||
|
||
```bash | ||
pipx install git+https://github.com/raestrada/[email protected].0-alpha1 | ||
pipx install git+https://github.com/raestrada/[email protected].1-alpha1 | ||
``` | ||
|
||
### Important: Before running the `storycraftr` command | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -310,7 +310,7 @@ <h1>Welcome to StoryCraftr 📚✨</h1> | |
<div class="coming-soon"> | ||
🚧 Coming Soon - Beta Release! 🚀 | ||
<br>Meanwhile, you can download the Alpha version, which is fully usable but may still have bugs: | ||
<code>pipx install git+https://github.com/raestrada/[email protected].0-alpha1</code> | ||
<code>pipx install git+https://github.com/raestrada/[email protected].1-alpha1</code> | ||
</div> | ||
</section> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters