Add some details on how to hack on filekäfer to the readme for posterity
This will likely end up helping me remember what I was doing in the future.
This commit is contained in:
parent
f2075cccb2
commit
3e663c4227
2
Makefile
2
Makefile
|
@ -15,7 +15,7 @@ clean: ## Clean up generated code
|
|||
example.log:
|
||||
while true; do date >> example.log; sleep 10; done;
|
||||
|
||||
run: ## Run against example.log (run `make example.log` in another console)
|
||||
run: build ## Run against example.log (run `make example.log` in another console)
|
||||
./target/debug/filekäfer -w ./example.log
|
||||
|
||||
watch: ## Watch the "test" topic in Kafka with kafkacat
|
||||
|
|
12
README.adoc
12
README.adoc
|
@ -49,6 +49,18 @@ Possible file positions are:
|
|||
* `START_OF_FILE`
|
||||
* `END_OF_FILE`
|
||||
|
||||
|
||||
== Hacking
|
||||
|
||||
Working with filekäfer is relatively straightforward, assuming
|
||||
link:https://rust-lang.org[Rust] is already present on the system. Docker and
|
||||
`docker-compose` are recommended, as is link:https://github.com/edenhill/kafkacat[kafkacat] for debugging.
|
||||
|
||||
Running `make` should output the available targets with a short description of
|
||||
each. For the most part `make run`, `make check`, and `make watch` will be used
|
||||
during development of filekäfer.
|
||||
|
||||
|
||||
== Similar tools
|
||||
|
||||
* link:https://github.com/Qihoo360/logkafka[logkafka]
|
||||
|
|
Loading…
Reference in New Issue