chore(docs): Add OS support in README #6990
Conversation
Codecov Report
@@ Coverage Diff @@
## development #6990 +/- ##
============================================
Coverage 59.82% 59.82%
============================================
Files 259 259
Lines 12875 12875
============================================
Hits 7702 7702
Misses 5173 5173 Continue to review full report at Codecov.
|
README.md
Outdated
| **NOTE :** If you are heading towards Local Installation, Be sure that you use one of the following operating systems : | ||
|
|
||
|
|
||
| * Debian based Linux Distribution |
There was a problem hiding this comment.
@iamareebjamal Should we also add a recommendation for Debian version to be 10, as in the README, we have the command sudo apt-get install python3.7 which will fail in Debian 9 as python3.7 is not available as a package in Debian 9.
There was a problem hiding this comment.
Most people use Ubuntu and don't know what's debian. So it should be Debian based Linux Distros (like Ubuntu) and no, we discourage using apt to install python because it will be always stuck with the distribution itself. Using pyenv is recommended as previously discussed. However, python installation is not the scope of this issue AFAIK
There was a problem hiding this comment.
@iamareebjamal Agree. @sanjana-302 Please make the following changes.
There was a problem hiding this comment.
@iamareebjamal @prateekj117 Thank you for suggestions. I will make mentioned changes.
README.md
Outdated
| @@ -40,6 +40,13 @@ A demo version is automatically deployed from our repositories: | |||
|
|
|||
| The Open Event Server can be easily deployed on a variety of platforms. Detailed platform-specific installation instructions have been provided below. | |||
|
|
|||
|
|
|||
| **NOTE :** If you are heading towards Local Installation, Be sure that you use one of the following operating systems : | |||
There was a problem hiding this comment.
| **NOTE :** If you are heading towards Local Installation, Be sure that you use one of the following operating systems : | |
| **NOTE:** If you are heading towards `Local Installation`, be sure to use one of the following operating systems: |
README.md
Outdated
|
|
||
|
|
||
| * Debian based Linux Distros (like Ubuntu) | ||
| * Macintosh Operating System |
There was a problem hiding this comment.
| * Macintosh Operating System | |
| * MacOS |
sanjana-302
changed the title
Okay. |
Fixes #6989
Short description of what this resolves:
Operating systems that are suitable for running the application have been mentioned in the README.md file itself. This will help the people who are new, to set up their system accordingly.
Checklist
developmentbranch.