Fix: Minor updates to Setup documentation on ReadMe #570
Conversation
LaibaBasit008
added
the
Status: Needs Review
|
@LaibaBasit008 change the PR title to follow the commit styles :) |
|
ping @LaibaBasit008 |
LaibaBasit008
changed the title
LaibaBasit008
force-pushed
the
536
branch
2 times, most recently
from
d38b1c2
to
5125ade
Compare
There was a problem hiding this comment.
@LaibaBasit008 Changes look good! This should be ready to merge once the conflicts are resolved.
Make sure to follow our https://github.com/anitab-org/portal/wiki/Commit-Message-Style-Guide, and also please expand on what you did in this PR, not just "Updated README.md"
LaibaBasit008
changed the title
|
@LaibaBasit008 The update message is not yet committed! |
I am sorry I didn't fully understand! |
I am sorry, I meant the committed message is not updated! If you see the first commit in the "Commits" tab, it's not updated to follow the Commit Message Guidelines. |
updated! |
|
@LaibaBasit008 You now have an extra commit, and the "Updated Readme.md" commit is not yet updated to follow the guidelines. Please ping on Zulip, if you need help. |
LaibaBasit008
force-pushed
the
536
branch
3 times, most recently
from
c1bf420
to
476608a
Compare
SanketDG
requested review from
theyashshahs,
ritwickraj78,
sakshi1499 and
satya7289
| you still get an error due to proxy, use "-E" flag along with "sudo" to export all the | ||
| environment variables. | ||
| 1. Make sure you have python3-dev installed on your operating system. For Debian, you would additionally require libpq-dev. | ||
| 3. Make sure you have python3-dev installed on your operating system. For Debian, you would additionally require libpq-dev. | ||
| Install by using `sudo apt-get install libpq-dev python3-dev` |
There was a problem hiding this comment.
Do we need this package libpq-dev python3-dev, because I have noticed while working with GitHub actions's setup it is not required (or not addtionally required for adding this package) see.
There was a problem hiding this comment.
I definitely think we need this because psycopg2 is a C-extension module, so it needs the header files for linking.
Are you sure about this?
| the `portal` directory. If working behind a proxy, follow the instructions [here](https://cms-sw.github.io/tutorial-proxy.html). | ||
| 1. Create a virtual environment with Python 3 and install dependencies: | ||
| 6. Create a virtual environment with Python 3.6 and install dependencies: |
There was a problem hiding this comment.
Users can create virtual env using python 3.7 also(Update need here).
| @@ -66,7 +69,7 @@ If you face some issues while installing and making Portal up in your local, hav | |||
| Setup for developers (Windows) | |||
| ------------------------------ | |||
|
|
|||
| 1. Make sure you have installed Python 3.6, make sure you the right one (32/64 bits). [Source](https://www.python.org/downloads/). During installation please pay attention to the following details : | |||
| 1. Make sure you have installed Python 3.6 or 3.7, make sure you the right one (32/64 bits). [Source](https://www.python.org/downloads/). During installation please pay attention to the following details : | |||
| - Tick/Select Add Python 3.6 to PATH | |||
There was a problem hiding this comment.
We can add here some detail here like if you choose Python 3.6 then Do this else Do that.
There was a problem hiding this comment.
Do you mean to expand on the PATH instructions?
There was a problem hiding this comment.
I think Satya wants one or two line on Path only :D
|
@SanketDG Are you pushing the changes in this or Laiba? |
sakshi1499
added
Status: Changes Requested
|
There are conflicts, some changes have to be made too. Closing this PR as there is no activity. |
Description
Changes have been made in ReadMe document to improve the environment setup process for both Windows and Linux
-Correctly Numbered the Steps
-dev.py path has been updates
-python version was corrected
-the command to find path/to/python has been added
Fixes #563
Type of Change:
Code/Quality Assurance Only
Checklist: