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: Banner + readme changes #83

Merged
merged 8 commits into from
Feb 8, 2023
Merged

docs: Banner + readme changes #83

merged 8 commits into from
Feb 8, 2023

Conversation

Penguax
Copy link
Contributor

@Penguax Penguax commented Feb 7, 2023

Added a banner to the top replacing # Capsule Farmer Evolved But still contains it as a fallback if image doesn't load.
Added img.shields icons for repo, linked to leagueofporo already.
Added readme contents table.
Moved discord and yt links up. Inside of Community Section
Organized Installation and added additional wording for windows installation.
Corrected --rm in docker commands
Added disclaimer at bottom.

-Added image to the top, has text incase of image failure. 
-Changed riot drops information link to be 2023 version.
-Remove `-rm` from docker command as its repeated after `--restart`.
added img.shield icons under banner
adding Readme Contents Section
added more README CONTENTS, added disclaimer, fixed some # in some lines. moved yt channel up.
@Penguax Penguax changed the title Banner + readme changes - docs Banner + readme changes Feb 7, 2023
@Penguax Penguax changed the title - docs Banner + readme changes docs: Banner + readme changes Feb 7, 2023
@alepouna alepouna added the documentation Improvements or additions to documentation label Feb 7, 2023
@alepouna
Copy link
Collaborator

alepouna commented Feb 7, 2023

Also, forgot to mention, remove the installation guides etc, and link the quickstart to the wiki. As well as the advanced installation/build your self, link to the wiki as well :)

Moved all installation guides to wiki
embed discord link
@Penguax
Copy link
Contributor Author

Penguax commented Feb 7, 2023

REMOVED READMES, CHECK NEW COMMENT
@auroraisluna
Wiki pages in markdown attached, Readme updated to remove the guides and link to wiki, google tv is included with the correct link if the PR is merged.

Docker Readme contains the docker run command without --rm and with --restart.

@Penguax Penguax requested a review from alepouna February 7, 2023 22:15
@Penguax
Copy link
Contributor Author

Penguax commented Feb 7, 2023

Advanced Installation for Synology Docker.md
Advanced Installation for Windows.md
Advanced Installation for Docker.md
Advanced Installation for Linux.md

Configuration link was done incorrectly, is now hard linked to wiki link for leagueofporo/capsulefarmerevolved.

Added Synology Docker readme

Credit: Synology Docker- Silver#0008

Copy link
Collaborator

@alepouna alepouna left a comment

Choose a reason for hiding this comment

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

LGTM

@alepouna
Copy link
Collaborator

alepouna commented Feb 7, 2023

Wiki changes are being pushed as we speak. Wait for @LeagueOfPoro to accept and merge.

@alepouna alepouna requested a review from LeagueOfPoro February 8, 2023 00:13
@LeagueOfPoro
Copy link
Owner

Looks good, merging

@LeagueOfPoro LeagueOfPoro merged commit a6c1220 into LeagueOfPoro:master Feb 8, 2023
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

Successfully merging this pull request may close these issues.

3 participants