Skip to content

Commit 56fbea9

Browse files
committed
docs: gtp
1 parent b53c63f commit 56fbea9

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

docs/inflator/gtp.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# [GTP](https://github.com/inflated-goboscript/gtp)
2+
3+
> The goboscript table of packages
4+
5+
The GTP is inflator's package index.
6+
7+
!!! Question "What's a package index?"
8+
9+
A package index is centralised, searchable repository of packages which package developers can use to
10+
distribute their packages.
11+
12+
The GTP stores a [key-value mapping](https://github.com/inflated-goboscript/gtp/blob/main/gtp.json)
13+
of (inflated) goboscript packages, which are easy to install.
14+
15+
## Installing from the package index
16+
17+
Installing from the GTP is very easy. Simply:
18+
19+
`inflate install <name>`
20+
21+
So long as <name\> is not located in the current working directory, inflator will look it up on the GTP.
22+
If it is found, it will install from the GitHub repository that the GTP registry refers to.
23+
24+
e.g. cmath -> [https://github.com/inflated-goboscript/cmath](https://github.com/inflated-goboscript/cmath)
25+
26+
## Registering a package on the package index
27+
28+
Register a package using [this issue template](https://github.com/inflated-goboscript/gtp/issues/new?template=register-package.yml).
29+
A bot will automatically close the issue and add it to the registry, if valid, within a minute.
30+
31+
The bot's source code is available [here](https://github.com/inflated-goboscript/bfg). It's called the bfg.
32+
33+
!!! Info
34+
35+
The bfg is currently hosted using [pythonanywhere](https://www.pythonanywhere.com/), which seems to be somewhat
36+
unstable. If the bot does not respond to your issue, ping me (@faretek1) on discord or GitHub, and I'll sort it out.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ nav:
131131
- Getting Started: inflator/usage/getting started.md
132132
- Installing Packages: inflator/usage/installing packages.md
133133
- Other commands: inflator/other commands.md
134+
- GTP: inflator/gtp.md
134135
- TW-CLI:
135136
- TW-CLI: tw-cli/index.md
136137
- Installation: tw-cli/installation.md

0 commit comments

Comments
 (0)