mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-03-05 20:49:04 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

chore: remove go-bindata references

Browse source
This commit is contained in:
Jan De Dobbeleer 2021-03-17 18:34:09 +01:00 committed by Jan De Dobbeleer
parent 996cb9d6f2
commit 6798da704b
1 changed files with 5 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
docs/docs/contributing-started.mdx
View file

@ -11,58 +11,18 @@ import TabItem from "@theme/TabItem";
### go
The code base is in [go][go], meaning we need a working go setup before we can do anything else.
The codebase is in [go][go], meaning we need a working go setup before we can do anything else.
Have a look at the [go guide][go-started] to get up and running with go in no time!
:::info
Oh my Posh needs at least go 1.16.
:::
### golangci-lint
To make sure we keep on writing quality code, [golang-ci lint][golang-ci-lint] is used to validate the changes.
Have a look at the [local installation guide][golang-ci-lint-local] to make sure you can validate this yourself as well.
### go-bindata
Oh my Posh packs the initialization scipts for the different shells, but go does not ship with the ability to add
files other than go code to your compiled binary. [go-bindata][go-bindata] allows us to add initialization files and
ship them in the source code to easily bootstrap your shell with Oh my Posh.
There are multiple ways to install go-bindata.
<Tabs
defaultValue="homebrew"
values={[
{ label: 'homebrew', value: 'homebrew', },
{ label: 'linux', value: 'linux', },
{ label: 'source', value: 'source', },
]
}>
<TabItem value="homebrew">
```bash
brew install go-bindata
```
</TabItem>
<TabItem value="linux">
```bash
curl --silent --location --output /usr/local/bin/go-bindata https://github.com/kevinburke/go-bindata/releases/download/v3.11.0/go-bindata-linux-amd64
chmod 755 /usr/local/bin/go-bindata
```
</TabItem>
<TabItem value="source">
```bash
go get -u github.com/kevinburke/go-bindata/...
```
Be careful as executing this inside the Oh my Posh repository will adjust the `go.mod` file with this dependency.
Today, there's no way to install a dependency system wide for go, although that's [in the works][go-global].
Make sure to remove this before submitting a PR as there's [a check][pr-go-mod] in place to avoid adding unused dependencies.
</TabItem>
</Tabs>
## Get the source code
The source is hosted on [Github][omp]. When you want to contribute, create a [fork][gh-fork] so you can make changes in