tfgrid/info_tfgrid
38
3
Fork 0
Code Issues 12 Pull Requests Packages Projects 3 Releases Activity

Update README.md

Browse Source 
set absolute links
This commit is contained in:
mik-tf 2024-04-02 21:00:42 +00:00
parent 30142a9375
commit 3a02594f3b
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -12,7 +12,7 @@
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).
To see the whole list of books, check the [heroscript directory](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript).
## Basic Hero mdBook Commands
@ -32,15 +32,15 @@ Once Hero is set on your machine, you can run the following commands to preview
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).
> Note: You can use -p instead of -u and set a path to your heroscript directory, as explained in the [docs](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/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).
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](./docs/hero_create_mdbooks.md).
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).
## Notes for Repo Owners