chore: add build instructions

hazcod · Mar 13, 2024 · c6d4e8a · c6d4e8a
1 parent 980448b
commit c6d4e8a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -4,6 +4,9 @@ GOLANG_CROSS_VERSION  ?= v1.17.6
 SYSROOT_DIR     ?= sysroots
 SYSROOT_ARCHIVE ?= sysroots.tar.bz2
 
+build:
+	go build -o enpass-cli ./cmd/...
+
 .PHONY: sysroot-pack
 sysroot-pack:
 	@tar cf - $(SYSROOT_DIR) -P | pv -s $[$(du -sk $(SYSROOT_DIR) | awk '{print $1}') * 1024] | pbzip2 > $(SYSROOT_ARCHIVE)

diff --git a/README.md b/README.md
@@ -53,6 +53,17 @@ Flags
 | `-trashed` | Show trashed items in the `list` and `show` command |
 | `-clipboardPrimary` | Use primary X selection instead of clipboard for the `copy` command |
 
+Development
+-----
+```shell
+# to run it from code
+% go run ./cmd/... -vault=foo list
+
+# to build it yourself
+% make build
+% ./enpass-cli -vault=foo list
+```
+
 Testing Code
 -------
 ```shell