Merge pull request 'updated readme' (!152) from dev_docs into development
Reviewed-on: #152
This commit is contained in:
commit
5b868741a9
15
README.md
15
README.md
@ -7,6 +7,7 @@
|
||||
- [Install and Use Hero](#install-and-use-hero)
|
||||
- [Create a New mdBook](#create-a-new-mdbook)
|
||||
- [Use Hero with Docker](#use-hero-with-docker)
|
||||
- [Basic Mdbook Info](#basic-mdbook-info)
|
||||
- [Contribute](#contribute)
|
||||
- [Branches and Forks](#branches-and-forks)
|
||||
- [Overview](#overview-1)
|
||||
@ -40,23 +41,23 @@ Once Hero is set on your machine, you can run the following commands to preview
|
||||
|
||||
## Install and Use Hero
|
||||
|
||||
install hero as follows
|
||||
You can install Hero with the following command:
|
||||
|
||||
```bash
|
||||
curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/installer_hero.sh | bash /tmp/hero_install.sh
|
||||
```
|
||||
|
||||
you can also do it on a VM (experts only)
|
||||
|
||||
To install and use Hero on a full VM running on the grid, read the [full VM guide](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md).
|
||||
|
||||
## Create a New mdBook
|
||||
|
||||
To create a new mdbook, read the [mdbook creation guide](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_create_mdbook.md).
|
||||
To create a new mdbook, read the [mdbook creation guide](./docs/hero_create_mdbook.md).
|
||||
|
||||
## Use Hero with Docker
|
||||
|
||||
You can use Hero with Docker. Read the docs [here](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_docker.md).
|
||||
You can use Hero with Docker. Read the docs [here](./docs/hero_mdbook_docker.md).
|
||||
|
||||
## Basic Mdbook Info
|
||||
|
||||
To get started with Mdbook before learning Hero Mdbook, read [this documentation](./docs/mdbook_basics.md).
|
||||
|
||||
## Contribute
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user