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 setup/build/install steps to the README #2

Closed
UebelAndre opened this issue Oct 8, 2020 · 2 comments
Closed

Add setup/build/install steps to the README #2

UebelAndre opened this issue Oct 8, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@UebelAndre
Copy link

Is your feature request related to a problem? Please describe.
This is probably something you planned to do but thought I'd explicitly ask for it

Describe the solution you'd like
I'd like to be able to run a few commands that I can get from the README.md to get this up and running

Describe alternatives you've considered
I don't think there are any alternatives here

Additional context
No additional context to add

@RLovelett
Copy link
Owner

It is a very valid concern and one that I am working to address.

Frankly, I have a few issues that to me are higher priority and directly block documentation. Namely swift build does not work (as it should). This is a side effect of Shout#34.

So I have been working on refactoring Shout out of the code base and implementing a libssh wrapper (instead of libssh2/Shout). That actually solves a few problems all at once.

This new branch is almost done. Once it is I will start working on documentation.

Thank you for the suggestion.

@RLovelett RLovelett added the documentation Improvements or additions to documentation label Oct 8, 2020
@RLovelett
Copy link
Owner

I've added commit 065bd11 which updates the README.md. This should address how to build and how to configure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants