Skip to content

Commit 4be1989

Browse files
authored
Update README.md
1 parent f2e0a21 commit 4be1989

File tree

1 file changed

+7
-23
lines changed

1 file changed

+7
-23
lines changed

README.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ It includes:
2020

2121
`Star` this repository if you find it valuable and worth maintaining.
2222

23+
`Watch` this repository to get notified about new releases, issues, etc.
24+
2325
## Usage
2426

2527
1. Click the `Use this template` button (alt. clone or download this repository).
@@ -54,21 +56,16 @@ It includes:
5456

5557
### Maintainance
5658

57-
1. `Watch` this repository to get notified about new releases, issues, etc.
58-
1. Update Go version in [Makefile](Makefile) and [devcontainer.json](.devcontainer/devcontainer.json).
59-
1. Update and add additional build tools in [install.sh](install.sh).
60-
1. Configure linters via [.golangci.yml](.golangci.yml).
61-
1. Update release configuration in [.goreleaser.yml](.goreleaser.yml).
62-
1. Develop Make targets in [Makefile](Makefile).
59+
Remember to update Go version in [Makefile](Makefile) and [devcontainer.json](.devcontainer/devcontainer.json).
6360

6461
Notable files:
65-
6662
- [devcontainer.json](.devcontainer/devcontainer.json) - Visual Studio Code Remote Container configuration
67-
- [.github](.github/workflows/build.yml) - GitHub Action workflow (CI build)
63+
- [.github/workflows](.github/workflows) - GitHub Actions workflows
6864
- [.vscode](.vscode) - Visual Studio Code configuration files
6965
- [.golangci.yml](.golangci.yml) - GolangCI-Lint configuration
66+
- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration
7067
- [install.sh](install.sh) - build tools installation script
71-
- [Makefile](Makefile) - Make targets used in [CI build](.github/workflows/build.yml) and [.vscode/tasks.json](.vscode/tasks.json)
68+
- [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json)
7269

7370
## FAQ
7471

@@ -79,20 +76,7 @@ The maintainer does not use GoLand. Fell free to create a pull request for [#2](
7976
### Why GitHub Actions, not any other CI server
8077

8178
GitHub Actions is out-of-the-box if you are already using GitHub.
82-
However, changing to any other CI server should be very simple, because this repository uses Docker to run CI build to make the transition easy.
83-
84-
For [CircleCI](https://circleci.com/docs/2.0/executor-types/#using-machine) create `.circleci/config.yml` file:
85-
86-
```yml
87-
version: 2.1
88-
jobs:
89-
build:
90-
machine:
91-
image: ubuntu-1604:201903-01
92-
steps:
93-
- checkout
94-
- run: make docker run="make all"
95-
```
79+
However, changing to any other CI server should be very simple, because this repository has build logic and tooling installation in Makefile.
9680

9781
## Contributing
9882

0 commit comments

Comments
 (0)