aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2022-01-30 11:33:37 +0700
committerShulhan <ms@kilabit.info>2022-01-30 11:33:37 +0700
commitb6c96bbfd14baff70932dd9fb4722d8e32f38a58 (patch)
treeb57c79df3134c6759aa827316a72a385f3b6ff86 /README.md
parentb5f28512de8cf3fcc7fe31fb7c11570816f86a0f (diff)
downloadbeku-b6c96bbfd14baff70932dd9fb4722d8e32f38a58.tar.xz
all: replace beku_test in testdata with gitsubmodule
Previously, the beku_test is bare clone of git repository stored as is. This cause an initial clone of the beku repository itself does not recognize it as git repository, which make the test fail: go test -v -coverprofile=cover.out ./... || rm -f cover.out fatal: '/home/ms/go/src/git.sr.ht/~shulhan/beku/testdata/beku_test.git' does not appear to be a git repository fatal: Could not read from remote repository. Please make sure you have the correct access rights and the repository exists. 2022/01/30 10:56:19 gitInstall: Clone: exit status 128 FAIL github.com/shuLhan/beku 0.008s This changes make the testdata/beku_test.git as git submodule, to make the test run well.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 21 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2fad7ab..4b593ac 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ For beku as library see the following
For beku as program see the below documentation or at
[![GoDoc](https://godoc.org/github.com/shuLhan/beku/cmd/beku?status.svg)](https://godoc.org/github.com/shuLhan/beku/cmd/beku).
-# Beku program
+## Beku program
Beku is command line program to manage packages in user's environment (GOPATH
or vendor directory). Beku provide syntax like `pacman`.
@@ -163,13 +163,31 @@ and checkout the commit `5c1cf69` as the working version.
Update all packages in database to new tag or commits with approval from
user.
-# Known Limitations
+
+## Development
+
+This repository use git submodules to test functionalities that use `git
+clone`.
+Command for cloning git repository for new development:
+
+ $ git clone --recurse-submodules <URL>
+
+or for existing clone,
+
+ $ git submodule update --init --recursive
+
+Then run `make` to make sure all test run well,
+
+ $ make
+
+## Known Limitations
- Only work with package hosted with Git on HTTPS or SSH.
- Tested only on Git v2.17 or greater
-# References
+
+## References
[1] https://www.archlinux.org/pacman/