Update Windows build instructions & contributing docs #4858

GongBingWong · 2023-10-02T03:54:16Z

Description

Based on my experience as a first time contributor, I added what I thought would be useful to know for other first time contributors.

I updated the 'BUILDING_ON_WINDOWS.md' file to include more steps for Qt, included how to add to PATH for Qt and conan 2, and added 'cd ..' as a step to build.

I updated the 'CONTRIBUTING.md' file (not really sure where to put general non-code related contribution info) to include what I learned with my contribution (the need to create a specific branch instead of using main, and also to update the 'CHANGELOG.md' file).

BUILDING_ON_WINDOWS.md

Based on Felanbird's observation.

Felanbird · 2023-10-02T04:05:54Z

BUILDING_ON_WINDOWS.md

+<details>
+   <summary>How to add conan 2 to PATH</summary>
+
+1. Type "path" in the start menu and click on the "Edit the system environment variables" result that shows up (this should open up the 'System Properties' window with the 'Advanced' tab selected).
+2. Press on the "Environment Variables..." button near the bottom right of the 'System Properties' window to open up the 'Environment Variables' window.
+3. Within 'Environment Variables', look at the bottom half of the window where it lists 'System variables' and double click on the variable named 'Path' to open up the 'Edit environment variable' window.
+4. Press the 'New' button near the top right to create a new environment variable.
+5. Open up your terminal with the Visual Studio environment variables (e.g. `x64 Native Tools Command Prompt for VS 2022`) and type "where conan" to find the file path (the folder that contains the conan.exe) to add.
+6. Add conan 2's file path (e.g. `C:\Users\willg\AppData\Roaming\Python\Python311\Scripts`) to the blank text box that shows up.
+7. Press the "OK" button.
+
+</details>
+


Suggested change

<details>

<summary>How to add conan 2 to PATH</summary>

1. Type "path" in the start menu and click on the "Edit the system environment variables" result that shows up (this should open up the 'System Properties' window with the 'Advanced' tab selected).

2. Press on the "Environment Variables..." button near the bottom right of the 'System Properties' window to open up the 'Environment Variables' window.

3. Within 'Environment Variables', look at the bottom half of the window where it lists 'System variables' and double click on the variable named 'Path' to open up the 'Edit environment variable' window.

4. Press the 'New' button near the top right to create a new environment variable.

5. Open up your terminal with the Visual Studio environment variables (e.g. `x64 Native Tools Command Prompt for VS 2022`) and type "where conan" to find the file path (the folder that contains the conan.exe) to add.

6. Add conan 2's file path (e.g. `C:\Users\willg\AppData\Roaming\Python\Python311\Scripts`) to the blank text box that shows up.

7. Press the "OK" button.

</details>

As noted by the instruction above, the default settings automatically setup PATH to recognize conan.

Yeah, you're right. I didn't even notice the "default setting". xD

Also do you know if the 'where conan' command only works if conan 2 is in PATH?

If so, maybe it could be used to verify conan 2 is in PATH.

BUILDING_ON_WINDOWS.md

CHANGELOG.md

CONTRIBUTING.md

BUILDING_ON_WINDOWS.md

Felanbird · 2023-10-02T04:57:53Z

CONTRIBUTING.md

@@ -2,6 +2,10 @@

 This is a set of guidelines for contributing to Chatterino. The goal is to teach programmers without a C++ background (java/python/etc.), people who haven't used Qt, or otherwise have different experience, the idioms of the codebase. Thus we will focus on those which are different from those other environments. There are extra guidelines available [here](https://hackmd.io/@fourtf/chatterino-pendantic-guidelines) but they are considered as extras and not as important.

+### General (non-code related) guidelines for contributing to Chatterino
+- Make a specific branch for your pull request instead of using the master, main, or mainline branch. This allows you to better manage your workflow and avoid conflicts with Chatterino's main branch name.
+- Update the CHANGELOG.md file to include bug fixes and features that you implemented. The number behind the changelog entry indicates the number of the pull request.


While it is true the changelog check will cry without a changelog, I don't think first time contributors should feel like they need to come up with a changelog entry, where applicable we'll just write one for you if one isn't included.

Ah okay, should that info be mentioned then?

I'd say just omit the changelog stuff, the branch thing is handy

Co-authored-by: Felanbird <[email protected]>

BUILDING_ON_WINDOWS.md

Nerixyz · 2023-10-02T07:03:07Z

BUILDING_ON_WINDOWS.md

@@ -82,19 +93,33 @@ Note: This installation will take about 200 MB of disk space.

 Install [conan 2](https://conan.io/downloads.html) and make sure it's in your `PATH` (default setting).

+<details>
+   <summary>How to add conan 2 to PATH</summary>


This adds python's scripts to PATH. Maybe this should read something like "Installing with pip" and include the pip install. Furthermore, I thought default python installations would add themselves to PATH by default.

Yeah, maybe its pip specific. I don't know if default python installations add themselves to PATH by default, I think I manually added conan 2 to PATH (don't remember if it was there before).

I'm probably just going to commit Felanbird's suggestion to remove it after I ask about something.

The reason I haven't committed it yet because I'm not sure if I should resolve a conversation (by doing a commit) when I still have a question about a related topic.

Thanks to Felanbird and Nerixyz.

BUILDING_ON_WINDOWS.md

pajlada · 2023-10-07T11:43:31Z

CONTRIBUTING.md

@@ -2,6 +2,10 @@

 This is a set of guidelines for contributing to Chatterino. The goal is to teach programmers without a C++ background (java/python/etc.), people who haven't used Qt, or otherwise have different experience, the idioms of the codebase. Thus we will focus on those which are different from those other environments. There are extra guidelines available [here](https://hackmd.io/@fourtf/chatterino-pendantic-guidelines) but they are considered as extras and not as important.

+### General (non-code related) guidelines for contributing to Chatterino
+- Make a specific branch for your pull request instead of using the master, main, or mainline branch. This allows you to better manage your workflow and avoid conflicts with Chatterino's main branch name.
+- Update the CHANGELOG.md file to include bug fixes and features that you implemented. The number behind the changelog entry indicates the number of the pull request.


I'd say just omit the changelog stuff, the branch thing is handy

Requested change from pajlada.

Nerixyz · 2023-10-09T08:06:57Z

BUILDING_ON_WINDOWS.md

@@ -28,15 +29,25 @@ Notes:
 #### When prompted which components to install:

 1. Unfold the tree element that says "Qt"
-2. Unfold the top most tree element (latest stable Qt version, e.g. `Qt 5.15.2`)
+2. Unfold the top most tree element (latest stable Qt version, e.g. `Qt 6.5.3`)


I know this is a bit late, but Qt 6.6.0 will be out tomorrow (most likely), and we noticed a bug in Qt 6.5.3 [not in 6.6], so I think it would be better to use 6.6.0 here, but it's not that big of a deal.

I'm ok with this not being the absolute latest or correct version since it's an example - as long as it's Qt 6 it'll be close enough

you installed it with pip

folder

Nerixyz

When reading the entire file, I noticed that we're saying Qt 5.12 and up are supported, even though on Windows, we're only supporting Qt 5.15 and up (technically 5.12 should still compile though).

Installing the latest stable Qt version is advised for new installations, but if you want to use your existing installation please ensure you are running Qt 5.12 or later.

BUILDING_ON_WINDOWS.md

Co-authored-by: nerix <[email protected]>

BUILDING_ON_WINDOWS.md

Co-authored-by: nerix <[email protected]>

GongBingWong added 5 commits October 1, 2023 23:12

Update BUILDING_ON_WINDOWS.md

f3d9167

Update CONTRIBUTING.md

7b4f0e4

Remove blank line

b34f557

Better wording

bc2e6f3

Update CHANGELOG.md

08786e3

Felanbird reviewed Oct 2, 2023

View reviewed changes

BUILDING_ON_WINDOWS.md Outdated Show resolved Hide resolved

More accurate Qt information

02b32fa

Based on Felanbird's observation.

Felanbird requested changes Oct 2, 2023

View reviewed changes

GongBingWong and others added 12 commits October 2, 2023 01:30

Removed unnecessary information

6f84874

Co-authored-by: Felanbird <[email protected]>

No changelog needed instead of updating CHANGELOG.md

a113396

Co-authored-by: Felanbird <[email protected]>

Update CONTRIBUTING.md

295a9fa

Co-authored-by: Felanbird <[email protected]>

Update step 4 of Qt PATH guide

c807430

Co-authored-by: Felanbird <[email protected]>

Update BUILDING_ON_WINDOWS.md

9f56537

Co-authored-by: Felanbird <[email protected]>

Remove unnecessary instruction

d6cf5d7

Co-authored-by: Felanbird <[email protected]>

Grammatical fix

c351ea5

Co-authored-by: Felanbird <[email protected]>

Clearer Qt PATH tutorial title

4bdd861

Co-authored-by: Felanbird <[email protected]>

Specify Windows start menu

a59803b

Co-authored-by: Felanbird <[email protected]>

Clearer and more concise step 2 PATH instruction

94c7c34

Co-authored-by: Felanbird <[email protected]>

More concise step 3 PATH instruction

764be69

Co-authored-by: Felanbird <[email protected]>

Specify what c2 is

4ff4f32

Nerixyz reviewed Oct 2, 2023

View reviewed changes

Remove unnecessary 'cd ..'

eb60291

Thanks to Felanbird and Nerixyz.

pajlada added the no changelog entry needed label Oct 7, 2023

pajlada requested changes Oct 7, 2023

View reviewed changes

GongBingWong added 3 commits October 9, 2023 00:00

Merge branch 'Chatterino:master' into betterdocs

111364c

Omit changelog guideline

e55bff8

Update Qt version

71316f7

Requested change from pajlada.

Nerixyz reviewed Oct 9, 2023

View reviewed changes

pajlada added 2 commits October 9, 2023 18:16

run formatter

63de1aa

Use C:\Users\example to be consistent with the rest of the doc

0fa996b

pajlada added 2 commits October 9, 2023 19:12

Udpate conan 2 installation hinnt to mention that it's only relevant if

a09150e

you installed it with pip

Update the second-to-last step with info that this is the python scripts

79eba20

folder

pajlada approved these changes Oct 9, 2023

View reviewed changes

pajlada requested review from Felanbird and Nerixyz October 9, 2023 17:13

Nerixyz reviewed Oct 9, 2023

View reviewed changes

pajlada and others added 7 commits October 9, 2023 19:54

Update BUILDING_ON_WINDOWS.md

433f5cd

Co-authored-by: nerix <[email protected]>

Update BUILDING_ON_WINDOWS.md

cb209ec

Co-authored-by: nerix <[email protected]>

replace 5.15.2 with 6.5.3, and Qt5 with Qt6

5f1a46c

add additional qt6 modules

87bc2ac

Update BUILDING_ON_WINDOWS.md

ae11be5

Co-authored-by: nerix <[email protected]>

Update BUILDING_ON_WINDOWS.md

891ee76

Co-authored-by: nerix <[email protected]>

Update BUILDING_ON_WINDOWS.md

5f8f297

Co-authored-by: nerix <[email protected]>

pajlada changed the title ~~Add better documentation for new contributors~~ Update Windows build instructions & contributing docs Oct 9, 2023

Nerixyz suggested changes Oct 9, 2023

View reviewed changes

BUILDING_ON_WINDOWS.md Outdated Show resolved Hide resolved

Update BUILDING_ON_WINDOWS.md

c0b8d23

Co-authored-by: nerix <[email protected]>

Nerixyz approved these changes Oct 9, 2023

View reviewed changes

Felanbird approved these changes Oct 9, 2023

View reviewed changes

pajlada enabled auto-merge (squash) October 9, 2023 18:19

pajlada merged commit d03151d into Chatterino:master Oct 9, 2023
15 checks passed

ilya-zlobintsev mentioned this pull request Jan 30, 2024

Add developer_name appdata field ilya-zlobintsev/chatterino2#3

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Windows build instructions & contributing docs #4858

Update Windows build instructions & contributing docs #4858

GongBingWong commented Oct 2, 2023

Felanbird Oct 2, 2023

GongBingWong Oct 2, 2023

Felanbird Oct 2, 2023

GongBingWong Oct 2, 2023

pajlada Oct 7, 2023

GongBingWong Oct 9, 2023

Nerixyz Oct 2, 2023

GongBingWong Oct 2, 2023

pajlada Oct 7, 2023

Nerixyz Oct 9, 2023

pajlada Oct 9, 2023

Nerixyz left a comment

Update Windows build instructions & contributing docs #4858

Update Windows build instructions & contributing docs #4858

Conversation

GongBingWong commented Oct 2, 2023

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nerixyz left a comment

Choose a reason for hiding this comment