Update README.md

add more info and links to docs
This commit is contained in:
mik-tf 2024-04-02 20:46:28 +00:00
parent 4be600da12
commit 625204a5ee

View File

@ -1,19 +1,47 @@
# INFO for TFGrid <h1> TFGrid Docs</h1>
<h2>Table of Contents</h2>
- [Overview](#overview)
- [Basic Hero mdbook Commands](#basic-hero-mdbook-commands)
- [Install and Use Hero](#install-and-use-hero)
- [Create a new mdbook](#create-a-new-mdbook)
- [Notes for Repo Owners](#notes-for-repo-owners)
## Overview
This repository contains TFGrid docs in the form of mdbooks generated with the [Hero](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero) tool.
To see the whole list of books, check the [heroscript directory](./heroscript).
## Basic Hero mdbook Commands
Once Hero is set on your machine, you can run the following commands to preview mdbooks on your local browser:
- Pull new changes
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp
```
- Build the book
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook
```
- Preview on a web browser
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -o
```
> Note: You can use -p instead of -u and set a path to your heroscript directory, as explained in the [docs](./docs).
## Install and Use Hero
To install and use Hero on a full VM running on the grid, read the [full VM guide](./docs/hero_fullvm.md).
## Create a new mdbook
To create a new mdbook, read the [mdbook creation guide](./docs/hero_create_mdbooks.md).
## Notes for Repo Owners
> todo: kristof some content does not belong here, move to other repo > todo: kristof some content does not belong here, move to other repo
## To preview new changes on local browser
1. Pull new changes from local
(please make sure commit / save your local changes first )
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp
2. Build the book locally
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook
3. Preview on web browser
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -o