Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add prerequisites for running locally in the README #35

Open
shivamshrey opened this issue Sep 18, 2022 · 4 comments
Open

Add prerequisites for running locally in the README #35

shivamshrey opened this issue Sep 18, 2022 · 4 comments
Labels
question Further information is requested

Comments

@shivamshrey
Copy link

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
Copy link
Owner

knadh commented Sep 19, 2022

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.

@knadh knadh added the question Further information is requested label Sep 19, 2022
@yashvardhan-kukreja
Copy link
Contributor

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
Copy link

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants