Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update INSTALL.md #378

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Update INSTALL.md #378

wants to merge 5 commits into from

Conversation

Mord5
Copy link

@Mord5 Mord5 commented Jul 24, 2022

added TC, regularized formatting, made explicit that WSL works for Win11, expanded handholding steps for Windows Cygwin install method

added TC, regularized formatting, made explicit that WSL works for Win11, expanded handholding steps for Windows Cygwin install method
@Mord5 Mord5 marked this pull request as draft July 24, 2022 07:29
Copy link
Member

@dannye dannye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is helpful! I just left a couple suggestions, but others can weigh in too.

INSTALL.md Show resolved Hide resolved

Now open the **Cygwin terminal** and enter the following commands.
Now open the **Cygwin terminal** and enter the following commands. You can open the terminal by double-clicking `Cygwin.bat`, which is in ``C:\cygwin64\``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cygwin.bat launches Cygwin within cmd which imo is not as good. I prefer to use C:\cygwin64\bin\mintty.exe.
But given that the choice is so subjective, I'm not sure we should be making any recommendation at all.

Copy link
Author

@Mord5 Mord5 Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

StackOverflow agrees with you regarding your choice of terminal, but for new users "open the Cygwin terminal" isn't a self-evident instruction so I think it's appropriate to offer some guidance.

If you use mintty as your terminal to launch the bash shell, you have to manually login to bash, whereas cmd via cygwin.bat handles that for you. It's a difference of two commands, which is not a lot in the grand scheme of things, but the audience here is specifically users in need of help, so I think it's justifiable to provide instructions that have fewer steps to get to the same place.

Assuming you plan to clone pokered into home/<user>, these are the commands needed to build pokered using mintty:

/bin/bash --login -i
cd /home/<user>
git clone https://github.com/pret/pokered
cd pokered
make

Whereas cmd via cygwin.bat only requires the latter 3 commands (which are currently included in the documentation).

Would it be excessive to document both methods of getting there such that all paths still converge on the existing "Build pokered" section as written?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you had a chance to consider the options re: instructing users how to open the cygwin terminal?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's been a long time since I've done a fresh cygwin install. Does the installer not simply put a mintty shortcut on your desktop?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not, no. (At least, it didn't for me.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's an option on the last page of the installer:

image

(I'm not sure if it's checked by default and unchecked here since I'm re-running the installer to update packages, or if it's unchecked by default now)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the desktop shortcut go to mintty?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes; the shortcut is C:\cygwin64\bin\mintty.exe -i /Cygwin-Terminal.ico -.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should note it's enabled by default, only disabled if there already is one.

INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Show resolved Hide resolved
@@ -15,50 +32,51 @@ Update WSL's software before continuing. If you chose Debian, Ubuntu, or another
apt-get update && apt-get upgrade
```

WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install pokered within Windows. You'll have to change the **current working directory** every time you open WSL.
WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install **pokered** within Windows. You'll have to change the **current working directory** every time you open WSL.
Copy link
Contributor

@vulcandth vulcandth Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install **pokered** within Windows. You'll have to change the **current working directory** every time you open WSL.
WSL has its own file system that is accessible by navigating to `\\wsl$\<Distro Name>\` using a Windows Explorer window. Windows files are accessible from WSL by navigating to `/mnt/c/` (equivalent to Windows `C:\`) from within the WSL environment. Due to WSL's poor Windows file access times, especially for WSLv2, it is currently recommended that you download the **pokered** repo to, and build from, the WSL file system.
(Replace <Distro Name> with the name of the distro you installed into WSL. By default this is Ubuntu. For example: `\\wsl$\Ubuntu\`)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install **pokered** within Windows. You'll have to change the **current working directory** every time you open WSL.
WSL has its own file system that's stored within Windows. You can use Windows Explorer to access the WSL file system by navigating to `\\wsl$\<Distro Name>\`. (Replace <Distro Name> in the example path with the name of the distro you installed into WSL. By default this is Ubuntu. For example: `\\wsl$\Ubuntu\`.)
You can also use WSL to access the Windows file system by navigating to `/mnt/c/` (equivalent to Windows `C:\`) from within the WSL environment. WSL - especially WSLv2 - is slow to access Windows files, so it's recommended that you store **pokered** in WSL's file system and build it from there.
Every time you open WSL, you will have to change the **current working directory** to navigate to wherever it is you have stored **pokered**. For instance, if you want to store **pokered** in your WSL's home directory, enter this command:
```bash
cd /home/<user>/
```
(Replace `<user>` in the example path with your WSL username.)

Not sure if the bit about changing working directory is accurate. If you store pokered in /home/<user>/ do you have to cd every time or is that only if you store somewhere else?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WSL typically launches with the default current directory of your home directory ~ or the equivalent /home/<user>. Typically you would want to install pokered in the /home/<user>/pokered. So in that instance, yes you would need to cd into pokered/ after launching WSL.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, thank you for clarifying. How do you feel about this text?

Suggested change
WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install **pokered** within Windows. You'll have to change the **current working directory** every time you open WSL.
WSL has its own file system that's stored within Windows. You can use Windows Explorer to access the WSL file system by navigating to `\\wsl$\<Distro Name>\`. (Replace <Distro Name> in the example path with the name of the distro you installed into WSL. By default this is Ubuntu. For example: `\\wsl$\Ubuntu\`.)
You can also use WSL to access the Windows file system by navigating to `/mnt/c/` (equivalent to Windows `C:\`) from within the WSL environment. WSL - especially WSLv2 - is slow to access Windows files, so it's recommended that you store **pokered** in WSL's file system and build it from there.
The default **current working directory** in WSL is your home directory, `/home/<user>/`. (Replace `<user>` in the example path with your WSL username.) If you store **pokered** in a different directory, you will have to change the **current working directory** every time you open WSL. For instance, if you want to store **pokered** in `/home/example/` use this command:
```bash
cd /home/example/
```

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you feel about the suggested text?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example should be for storing inside your home user directory. /home/<user>/.
That way when type type git clone <pokered-repo-link> the creates a folder for pokered. /home/<user>/pokred/

So rewriting the last sentence should say somethin like. For instance, if you want to store **pokered** in your home user directory `/home/<user>/` use this command:

```bash
cd /home/<user>/
```

INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
Mord5 and others added 3 commits July 29, 2022 22:25
Co-authored-by: vulcandth <vulcandth@gmail.com>
Co-authored-by: vulcandth <vulcandth@gmail.com>
Co-authored-by: vulcandth <vulcandth@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants