Skip to content

Commit

Permalink
Merge pull request #104 from rvion/rvion-patch-5
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
rvion authored Dec 10, 2023
2 parents 0374302 + 1e0f73e commit de9ca71
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<!-- <img height="21" alt="Sponsors" src="https://img.shields.io/github/sponsors/rvion" /> -->


_🔶 NOTICE: CushyStudio is still in development. It updates and breaks often. We are working hard to make a stable version. Current Focus is fixing the lack of variosu error message related to missing custom ComfyUI nodes 🔶_
_🔶 NOTICE: CushyStudio is still in development. It updates and breaks often. We are working hard to make a stable version. Current Focus is on improving the install experience and switching to some real production-ready database 🔶_


<br />
Expand Down Expand Up @@ -81,29 +81,41 @@ https://github.com/rvion/CushyStudio/assets/2150990/776b00f5-687e-4043-8dac-34df

# 2. Installation

<!--
1. Requirements:
1. [ComfyUI](https://github.com/comfyanonymous/ComfyUI) (local, remote, or cloud) ([install](https://github.com/comfyanonymous/ComfyUI#installing))
2. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (to install via git)
2. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (to install via git) -->

2. run those commands in a terminal (< 10 seconds to complete):
1. download this repository,
```sh
git clone https://github.com/rvion/CushyStudio --depth 1
cd CushyStudio
```

2. click
1. `_windows_INSTALL.bat` (on windows)
2. `_macos_INSTALL.sh` (on macos)
3. `_linux_INSTALL.sh` (on linux)

```sh

git clone https://github.com/rvion/CushyStudio --depth 1
cd CushyStudio
npm install
npm start
```

# 3. Quickstart Guide

## 3.1. Starting

You can start **CushyStudio** in two ways:

- By running `npm start` in a terminal, at the root of your CushyStudio install
- By running the `2_run.sh` (Mac, Linux) or `2_run.bat` (Windows)

2. click
1. `_windows_START.bat` (on windows)
2. `_macos_START.sh` (on macos)
3. `_linux_START.sh` (on linux)


<!-- You can start **CushyStudio** in two ways: -->

<!-- - By running `npm start` in a terminal, at the root of your CushyStudio install
- By running the `2_run.sh` (Mac, Linux) or `2_run.bat` (Windows)
-->

## 3.2. Updating

Expand Down

0 comments on commit de9ca71

Please sign in to comment.