Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Update README go installation #67

Merged
merged 1 commit into from
Jan 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ refer to a skilled trades-person or artisan.

## Features

### 1. Generate Project Structure from YAML
### Generate Project Structure from YAML

Fundi generates a project structure using a YAML configuration file that specifies the desired directory structure.
Files within the directories can be customized using `go` templates.

### 2. Generate Project Files from Local Templates
### Generate Project Files from Local Templates

Fundi can use templates stored on your local machine to create project files. This enables developers to define and
reuse custom templates tailored to specific project requirements.

### 3. Generate Project Files from Remote Templates (Coming Soon)
### Generate Project Files from Remote Templates (Coming Soon)

Fundi can fetch templates from remote Git repositories (e.g., GitHub or other Git hosting platforms) and generate
project files. This simplifies collaboration by allowing teams to share and maintain templates in a centralized
Expand Down Expand Up @@ -101,11 +101,11 @@ Follow these steps to install **Fundi** on your system:

---

### Install using Go
### Install from source using go install
To install Fundi, you can use the go install command:

```bash
$ go install github.com/kasulani/go-fundi
go install github.com/kasulani/go-fundi/cmd/fundi@latest
```

This will install **Fundi** in your `$GOBIN` directory, which is typically located at `$GOPATH/bin`. Make sure that this
Expand All @@ -115,7 +115,16 @@ terminal.
If you encounter any errors during the installation process, try running

```bash
$ go clean -i github.com/kasulani/go-fundi
#!/bin/bash
# Clean Go build and module cache for fundi
go clean -cache -modcache -i -r github.com/kasulani/go-fundi

# Remove binaries from GOPATH or GOBIN
rm -f $(go env GOBIN)/fundi
rm -f $(go env GOPATH)/bin/fundi

# Remove local artifact directories
rm -rf ./bin ./dist
```

to clean any existing build artifacts before running the go install command again.
Expand Down
Loading