Skip to content

Commit

Permalink
docs: updates readme with build instructions (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
matt-primrose authored Feb 16, 2024
1 parent cd8e4a9 commit 781c810
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ test:
## build: build a binary
.PHONY: build
build: test
go build -ldflags -H=windowsgui -o dmc.exe -v ./cmd/main.go
go build -ldflags -H=windowsgui -o console.exe -v ./cmd/main.go

## docker-build: build project into a docker container image
.PHONY: docker-build
Expand Down
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# go-htmx-tailwind-example
# Console

Example CRUD app written in Go + HTMX + Tailwind CSS
A web-based UI for connecting to and managing Intel(r) Active Management Technology (AMT) devices over the local network.

This project implements a pure dynamic web app with SPA-like features but without heavy complex Javascript or Go frameworks to keep up with. Just HTML/CSS + Go ❤️
Running the Console application will automatically launch the UI in the default browser. How to use:
1. Click the "Add Device" button and provide connection information for the Intel(r) AMT device (friendly name, IP Address, AMT Credential). For AMT 16.1 and newer systems, "Use TLS" is required and "Self-Signed OK" is required if TLS has not been configured.
2. Click "Connect" and Console will connect to the device and show the AMT device page with information gathered from the AMT device.

![screenshot](./screenshot.jpeg)

## Prequisites
## Developer Setup

### Prequisites
- Tailwind
``` bash
# Example for macOS arm64
Expand All @@ -25,7 +29,7 @@ chmod +x tailwindcss-linux-x64
mv tailwindcss-linux-x64 tailwindcss
```

## Develop
### Develop

```
Choose a make command to run
Expand All @@ -39,3 +43,8 @@ mv tailwindcss-linux-x64 tailwindcss
css build tailwindcss
css-watch watch build tailwindcss
```

### Build
```bash
go build -ldflags -H=windowsgui -o console.exe -v ./cmd/main.go
```
Binary file modified screenshot.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 781c810

Please sign in to comment.