summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index ee8e555..c24b68b 100644
--- a/README.md
+++ b/README.md
@@ -8,18 +8,28 @@ You'll need Go toolchain. Get it [here](https://go.dev/dl/)
```
git clone https://git.sr.ht/~rctt/solec
-cd solecd
+cd solec
go run cmd/daemon/main.go
```
+## Development
+
+Use following to setup Git hooks:
+`git config --local core.hooksPath hooks`
+
+* `tools/run.sh` - build and start server and few clients
+* `tools/build-spec.sh` - build Kaitai spec
+
## Wireshark plugin
To build wireshark plugin you'll need Kaitai Struct Compiler.
KSC currently doesn't support Wireshark plugin generation but
[there is a discussion]("https://github.com/kaitai-io/kaitai_struct/issues/50#issuecomment-1485044090").
-After building foked KSC use `./build_spec.sh` to build the plugin and then put
+After building foked KSC use `./tools/build_spec.sh` to build the plugin and then put
it into Wireshark plugins directory.
+There is a problem with dissecting specific payloads.
+
## TODO
- Protocol