Add System Requirements into README.md #295
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RLKRo
reviewed
Dec 3, 2023
|
|
||
| ## System Requirements | ||
|
|
||
| - Supported operating systems include Ubuntu 18.04+, Windows 10+ (partial support), and MacOS Big Sur (partial support); |
There was a problem hiding this comment.
Why partial support?
We don't test them because of docker. I don't think there's anything else we don't support (and docker can be launched on these platforms).
| ## System Requirements | ||
|
|
||
| - Supported operating systems include Ubuntu 18.04+, Windows 10+ (partial support), and MacOS Big Sur (partial support); | ||
| - Python version 3.8 or higher is necessary for proper functionality; |
There was a problem hiding this comment.
Too much text
Suggested change
| - Python version 3.8 or higher is necessary for proper functionality; | |
| - Python version 3.8 or higher; |
|
|
||
| - Supported operating systems include Ubuntu 18.04+, Windows 10+ (partial support), and MacOS Big Sur (partial support); | ||
| - Python version 3.8 or higher is necessary for proper functionality; | ||
| - A minimum of 1 GB of RAM is required for optimal performance; |
There was a problem hiding this comment.
These words don't mix well together. ("minimum", "required" and "optimal" are all about putting some restrictions on the amount of RAM)
Suggested change
| - A minimum of 1 GB of RAM is required for optimal performance; | |
| - 1 GB of RAM is recommended for optimal performance; |
| - Supported operating systems include Ubuntu 18.04+, Windows 10+ (partial support), and MacOS Big Sur (partial support); | ||
| - Python version 3.8 or higher is necessary for proper functionality; | ||
| - A minimum of 1 GB of RAM is required for optimal performance; | ||
| - If analytics collection or database integration is intended, Docker version 20 or higher may be necessary. |
RLKRo
pushed a commit
that referenced
this pull request
Dec 27, 2023
(cherry picked from commit ad31663)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Please describe here what changes are made and why.
Checklist
List here tasks to do in order to complete this PR.
To Consider
.ignorefiles, scripts (such aslint), distribution manifest (if files are added/deleted)