Add installation instruction as readme
This commit is contained in:
58
readme.md
Normal file
58
readme.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# XO-CLI & XO-TUI
|
||||
|
||||
## Installation
|
||||
|
||||
### Full Installation
|
||||
```bash
|
||||
# Create a new directory since we are going to be pulling in engine too
|
||||
mdkir xo-terminal && cd xo-terminal
|
||||
|
||||
# Clone the Engine Repo
|
||||
git clone git@gitlab.com:GeneralProtocols/xo/engine.git
|
||||
|
||||
# Move into teh engine directory
|
||||
cd engine
|
||||
|
||||
# Install the dependencies
|
||||
npm ci
|
||||
|
||||
# Build the engine
|
||||
npm run build
|
||||
|
||||
# Move back to the top level directory
|
||||
cd ..
|
||||
|
||||
# Clone the CLI Repo
|
||||
git clone git@git.harvmaster.com:Harvmaster/xo-cli.git
|
||||
|
||||
# Move into the cli directory
|
||||
cd xo-cli
|
||||
|
||||
# Install the dependencies
|
||||
npm ci
|
||||
|
||||
# Build the cli
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Install globally
|
||||
|
||||
```bash
|
||||
# (From the xo-cli directory)
|
||||
npm install -g .
|
||||
```
|
||||
|
||||
### Run the CLI
|
||||
```bash
|
||||
# If globally installed (Not really usable if not globally installed)
|
||||
xo-cli
|
||||
```
|
||||
|
||||
### Run the TUI
|
||||
```bash
|
||||
# If globally installed
|
||||
xo-tui
|
||||
|
||||
# If not globally installed
|
||||
npm run dev
|
||||
```
|
||||
Reference in New Issue
Block a user