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

docs: Updated compile/build information for macOS and Linux #691

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

z3cko
Copy link

@z3cko z3cko commented Aug 6, 2023

Updated the information on how to build the source on Mac OS X and Linux.

Updated the information of building from source to match the latest go 1.20+ and Mac OS X steps. Confirmed on Linux (Arch).
@@ -30,10 +30,11 @@ On Windows, you can simply set the `PATH` by using the advanced system settings.

## Building From Source

Shiori uses Go module so make sure you have version of `go >= 1.14.1` installed, then run:
Shiori uses Go module so make sure you have version of `go >= 1.14.1` installed. In the cloned git repository run:

```
go get -u -v github.com/go-shiori/shiori
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to just switch this command to go install github.com/go-shiori/shiori, right? That will build and install the command from source directly without cloning the repository (which is what the old documentaton wanted to achieve I guess).

What do you think?

@fmartingr fmartingr changed the title Updated compile/build information docs: Updated compile/build information for macOS and Linux Aug 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants