tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity

Merge pull request 'updated readme' (!152) from dev_docs into development

Browse Source 
Reviewed-on: #152
This commit is contained in:
mik-tf 2024-10-23 03:42:29 +00:00
commit 5b868741a9
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -7,6 +7,7 @@
- [Install and Use Hero](#install-and-use-hero) - [Install and Use Hero](#install-and-use-hero)
- [Create a New mdBook](#create-a-new-mdbook) - [Create a New mdBook](#create-a-new-mdbook)
- [Use Hero with Docker](#use-hero-with-docker) - [Use Hero with Docker](#use-hero-with-docker)
- [Basic Mdbook Info](#basic-mdbook-info)
- [Contribute](#contribute) - [Contribute](#contribute)
- [Branches and Forks](#branches-and-forks) - [Branches and Forks](#branches-and-forks)
- [Overview](#overview-1) - [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 and Use Hero
install hero as follows You can install Hero with the following command:
```bash ```bash
curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/installer_hero.sh | bash /tmp/hero_install.sh 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 ## 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 ## 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 ## Contribute