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

Make the separate page for installation instructions, improve README.md #3697

Merged
merged 13 commits into from Jun 21, 2021

Conversation

oleg-derevenetz
Copy link
Collaborator

@oleg-derevenetz oleg-derevenetz commented Jun 15, 2021

Changelist:

  • All installation instructions for pre-built binaries are moved from README.md to doc/INSTALL.md and made more detailed;
  • Fixed links to other markdown files in README.md (they used to be handled incorrectly with GitHub Pages), added link to the build instructions for PS Vita.

You can get the overall impression of changes in GitHub Pages mode here: https://oleg-derevenetz.github.io/fheroes2/

@oleg-derevenetz oleg-derevenetz added the improvement New feature, request or improvement label Jun 15, 2021
@oleg-derevenetz oleg-derevenetz added this to the 0.9.5 milestone Jun 15, 2021
README.md Outdated Show resolved Hide resolved
doc/INSTALL.md Outdated Show resolved Hide resolved
doc/INSTALL.md Outdated Show resolved Hide resolved

### Debian-based

Run the script `install_sdl_1.sh` or `install_sdl_2.sh` (depending on the downloaded build) from the `script/linux` subdirectory.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: add APT links for Ubuntu. Maybe in another PR.

doc/INSTALL.md Outdated Show resolved Hide resolved
Co-authored-by: Arkadiy Illarionov <qarkai@gmail.com>
Copy link
Contributor

@qarkai qarkai left a comment

Choose a reason for hiding this comment

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

LGTM

@oleg-derevenetz oleg-derevenetz added the deployment Deployment stuff (distributions, installers, etc) label Jun 21, 2021
@ihhub
Copy link
Owner

ihhub commented Jun 21, 2021

Hi @oleg-derevenetz , I have some idea how to make this even more user friendly. Since many (according to statistics) use our deployed website could we just create a separate MD file for this website which will be the main page and making it more user friendly. We could go even with few pages if needed.

I think @Branikolog had multiple suggestions about it.

Of course it's a bit out of the scope of this pull request and we can move to a Discussion topic if needed.

@oleg-derevenetz
Copy link
Collaborator Author

Hi @ihhub

The proposed INSTALL.md file is already a part of this deployed website, you can see it here:

https://oleg-derevenetz.github.io/fheroes2/

This is how you website will look after the merge of this PR.

@ihhub ihhub merged commit 2e0226c into ihhub:master Jun 21, 2021
@ihhub
Copy link
Owner

ihhub commented Jun 21, 2021

@oleg-derevenetz , thanks a lot for improving the documentation!

@oleg-derevenetz
Copy link
Collaborator Author

oleg-derevenetz commented Jun 21, 2021

Hi @ihhub and @Branikolog if there will be any specific ideas regarding website improvement (or better yet, a some sort of a sketch), let's discuss :) I think, @Branikolog can make a PR (I can help in technical terms, if necessary).

@oleg-derevenetz oleg-derevenetz deleted the readme-improvement branch June 21, 2021 15:43
@Branikolog
Copy link
Collaborator

Hi, @oleg-derevenetz !
I definitely have some ideas as well a feedback from our community regarding website. We should make it as friendly and clear as possible.
Not sure, that I can make a PR, but I can write here a little bit of my thoughts. Tomorrow, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployment Deployment stuff (distributions, installers, etc) improvement New feature, request or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants