Update readme
This commit is contained in:
@@ -2,114 +2,20 @@
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Full Installation
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create a new directory since we are going to be pulling in engine too
|
|
||||||
mkdir xo-terminal && cd xo-terminal
|
|
||||||
|
|
||||||
# ----- Start State Setup -----
|
|
||||||
# Clone the State Repo
|
|
||||||
git clone https://gitlab.com/Harvmaster/state.git
|
|
||||||
|
|
||||||
# Move into the state directory
|
|
||||||
cd state
|
|
||||||
|
|
||||||
git checkout cli-test
|
|
||||||
|
|
||||||
# Install the dependencies
|
|
||||||
npm ci
|
|
||||||
|
|
||||||
# Build the state
|
|
||||||
npm run build
|
|
||||||
# ----- End State Setup -----
|
|
||||||
|
|
||||||
# Move back to the top level directory
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
# ----- Start Primitive Setup -----
|
|
||||||
git clone git@gitlab.com:GeneralProtocols/xo/primitives.git
|
|
||||||
|
|
||||||
cd primitives
|
|
||||||
|
|
||||||
git checkout update/syncup-ui-requirements
|
|
||||||
|
|
||||||
npm ci
|
|
||||||
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
# ----- End Primitive Setup -----
|
|
||||||
|
|
||||||
# Move back to the top level directory
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
# ----- Start Utils Setup -----
|
|
||||||
git clone git@gitlab.com:Harvmaster/xo-cash-utils.git utils
|
|
||||||
|
|
||||||
cd utils
|
|
||||||
|
|
||||||
git checkout sse-and-backoff
|
|
||||||
|
|
||||||
npm ci
|
|
||||||
|
|
||||||
npm run build
|
|
||||||
# ----- End Utils Setup
|
|
||||||
|
|
||||||
# Move back to the top level directory
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
# ----- Start Template Setup ----
|
|
||||||
# Clone the Template repo
|
|
||||||
git clone https://gitlab.com/Harvmaster/templates.git
|
|
||||||
|
|
||||||
# Move into themplates directory
|
|
||||||
cd templates
|
|
||||||
|
|
||||||
# Install deps
|
|
||||||
npm ci
|
|
||||||
|
|
||||||
#build the templates
|
|
||||||
npm run build
|
|
||||||
# ----- End Templates Setup ----
|
|
||||||
|
|
||||||
# Move back to the top level directory
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
# ----- Start Engine Setup -----
|
|
||||||
# Clone the Engine Repo (Note, this uses harvey's fork of the engine repo to access the cli-test branch)
|
|
||||||
git clone https://gitlab.com/Harvmaster/engine.git
|
|
||||||
|
|
||||||
# Move into teh engine directory
|
|
||||||
cd engine
|
|
||||||
|
|
||||||
# Checkout the cli-test branch
|
|
||||||
git checkout cli-test-update
|
|
||||||
|
|
||||||
# Install the dependencies
|
|
||||||
npm ci
|
|
||||||
|
|
||||||
# Build the engine
|
|
||||||
npm run build
|
|
||||||
# ----- End Engine Setup -----
|
|
||||||
|
|
||||||
# Move back to the top level directory
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
# ----- Start CLI Setup -----
|
|
||||||
# Clone the CLI Repo
|
# Clone the CLI Repo
|
||||||
git clone https://git.harvmaster.com/Harvmaster/xo-cli.git
|
git clone https://git.harvmaster.com/Harvmaster/xo-cli.git
|
||||||
|
|
||||||
# Move into the cli directory
|
# Move into the cli directory
|
||||||
cd xo-cli
|
cd xo-cli
|
||||||
|
|
||||||
git checkout kiok-update
|
git checkout engine-v0.0.2
|
||||||
|
|
||||||
# Install the dependencies
|
# Install the dependencies
|
||||||
npm ci
|
npm ci
|
||||||
|
|
||||||
# Build the cli
|
# Run the CLI
|
||||||
npm run build
|
npm run dev
|
||||||
# ----- End CLI Setup -----
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run TUI in dev mode
|
### Run TUI in dev mode
|
||||||
@@ -118,6 +24,8 @@ npm run build
|
|||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Not fully tested past this point
|
||||||
|
|
||||||
### Install globally
|
### Install globally
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user