Skip to content

Commit

Permalink
chore: doc updated(Get an editor)
Browse files Browse the repository at this point in the history
  • Loading branch information
lnu authored and JanDeDobbeleer committed Dec 29, 2020
1 parent 36e69a1 commit 9013a5b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 5 deletions.
19 changes: 17 additions & 2 deletions docs/docs/contributing-started.mdx
Expand Up @@ -65,8 +65,8 @@ Make sure to remove this before submitting a PR as there's [a check][pr-go-mod]

## 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 your repository
and create pull request in the official Oh my Posh repository.
The source is hosted on [Github][omp]. When you want to contribute, create a [fork][gh-fork] so you can make changes in
your repository and create pull request in the official Oh my Posh repository.

Clone your fork of Oh my Posh locally, replace `<user>` with your Github username.

Expand Down Expand Up @@ -108,6 +108,21 @@ your path to add your own Oh my Posh binary to and immediately see the changes a
go build -o $GOPATH/bin/oh-my-posh
```

## Get an editor

A default config(.vscode folder) for [Visual Studio Code](https://code.visualstudio.com) is available in the repo:

- golangci-lint is configured as the default linter.
- Recommended extensions available for a smooth bootstrap.

![recommended extensions](recommended_extensions.png "Recommended extensions" )
- Default run and debug configurations available.

Once the extensions are installed:

- Debug can be started by hitting F5.
- All tests can be run using the Test explorer.

## Up Next

With everything set up, you're ready to start making changes and create your first [PR][gh-pr]!
Expand Down
Binary file added docs/docs/recommended_extensions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/engine.go
Expand Up @@ -204,8 +204,8 @@ func (e *engine) debug() {
segmentTiming.stringDuration = time.Since(start)

// not pretty rendering could be refactored for a better separation of concern
e.previousActiveSegment = nil
e.activeSegment = segment
e.endPowerline()
e.activeSegment.Background = segment.props.background
e.activeSegment.Foreground = segment.props.foreground
e.renderSegmentText(segmentTiming.stringValue)
Expand Down
4 changes: 2 additions & 2 deletions src/main.go
Expand Up @@ -154,9 +154,9 @@ func main() {

if *args.Debug {
engine.debug()
} else {
engine.render()
return
}
engine.render()
}

func initShell(shell, config string) string {
Expand Down

0 comments on commit 9013a5b

Please sign in to comment.