Skip to content

Commit 8225dc8

Browse files
authored
Merge pull request #2675 from tsadler1988/contributing-suggested-changes
CONTRIBUTING.md suggested changes
2 parents ec4a074 + 8afb213 commit 8225dc8

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Requirements
44

5-
- Python 3.11
5+
- Python 3.11 (later versions may not work)
66
- Git CLI installed
77
- Python, pip and git are all available as command-line commands (add to the path if needed)
88

@@ -26,6 +26,7 @@ Activate the virtual environment
2626

2727
```
2828
For cmd.exe: PyfaEnv\scripts\activate.bat
29+
For PowerShell: PyfaEnv\Scripts\Activate.ps1
2930
For bash: source <venv>/Scripts/activate
3031
```
3132
> For other OS check [Python documentation](https://docs.python.org/3/library/venv.html)
@@ -36,15 +37,17 @@ pip install -r PyfaDEV\requirements.txt
3637
```
3738
> For some Linux distributions, you may need to install separate wxPython bindings, such as `python-matplotlib-wx`
3839
40+
> You may need to [install a C compiler](https://mesonbuild.com/SimpleStart.html#installing-a-compiler-toolchain)
41+
3942
Check that the libs from *requirements.txt* are installed
4043
```
4144
pip list
4245
```
4346

4447
Build translations and database:
4548
```
46-
python scripts\compile_lang.py
47-
python db_update.py
49+
python PyfaDEV\scripts\compile_lang.py
50+
python PyfaDEV\db_update.py
4851
```
4952

5053
Test that the project is starting properly
@@ -88,6 +91,7 @@ Check that the project is starting properly.
8891
Switch to the proper virtual environment
8992
```
9093
For cmd.exe: PyfaEnv\scripts\activate.bat
94+
For PowerShell: PyfaEnv\Scripts\Activate.ps1
9195
For bash: source <venv>/Scripts/activate
9296
```
9397

0 commit comments

Comments
 (0)