knadh / dns.toys

A DNS server that offers useful utilities and services over the DNS protocol. Weather, world time, unit conversion etc.
https://www.dns.toys
MIT License
2.48k stars 135 forks source link

Add prerequisites for running locally in the README #35

Open shivamshrey opened 1 year ago

shivamshrey commented 1 year ago

Add supported platforms e.g. Windows, Linux, and the steps for it. Add a list of software to be installed as a prerequisite e.g. Go.

knadh commented 1 year ago

Hi @shivamshrey. Go is the only prerequisite, which is obvious as this is a Go code repository. make build should then work on most platforms.

I'm unable to figure out the build step on Windows. Please feel free to document if you're able to.

yashvardhan-kukreja commented 1 year ago

Hi @shivamshrey , in case you proceed with writing the doc, here's a suggestion from my end: Can you add an extra step under "Running locally" in README about the dig command to query against the locally running server.

i.e. dig <query> @127.0.0.1 -p 5354. For example, dig 1d6.dice @127.0.0.1 -p 5354

Pranav4399 commented 1 year ago

Hello @shivamshrey , In case you're running windows, were you able to build the Makefile on windows. The process is stuck for me for close to 20 mins. Do let me know in case you've gone past the build step on windows. Thanks.

shivamshrey commented 1 year ago

Hey @Pranav4399, I haven't been able to look into this yet! Will update here when I do.