Skip to content

A bit of clarification #283

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Apr 26, 2023
Merged

A bit of clarification #283

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2eff982
Update README.md
nPHYN1T3 Apr 24, 2023
b5c0b25
Update README.md
nPHYN1T3 Apr 24, 2023
f3ad4bb
Update README.md
nPHYN1T3 Apr 24, 2023
ad6351a
Should fix the win paths
nPHYN1T3 Apr 25, 2023
545577b
Fixed Windows style path for home
nPHYN1T3 Apr 25, 2023
604e92e
Hmmm
nPHYN1T3 Apr 25, 2023
821ad95
Update README.md
nPHYN1T3 Apr 25, 2023
df10841
ARG!
nPHYN1T3 Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,37 @@ A starting point for Neovim that is:

This repo is meant to be used as by **YOU** to begin your Neovim journey; remove the things you don't use and add what you miss.

Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. If you are experiencing issues, please make sure you have the latest versions.

Distribution Alternatives:
- [LazyVim](https://www.lazyvim.org/): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)

### Installation

Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. If you are experiencing issues, please make sure you have the latest versions.
* Backup your previous configuration (if any exists)

### Archive Installation
* On the home/landing page for the project find the blue "<> CODE" button click it and select Local > Download ZIP.
* Extract the archive to:
`~/.config/nvim` (Linux)
`~/.config/nvim` (MacOS)
`~/AppData/Local/nvim/` (Windows)
* Ensure your extraction method did not extract with a parent folder. For example in ~/.config/nvim you should have init.lua not another folder called kickstart.nvim.

### GIT Clone Installation
* From a terminal cd/dir to:
`~/.config/nvim` (Linux)
`~/.config/nvim` (MacOS)
`~/AppData/Local/nvim/` (Windows)
Copy link
Collaborator

@feoh feoh Apr 25, 2023

Choose a reason for hiding this comment

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

Will this actually work? I've had trouble with tilde expansion in Windows. You might actually consider using $HOME across the board. It's guaranteed to work everywhere :)

Also, aren't the path separators in Windows ?

* run: git clone https://github.com/nvim-lua/kickstart.nvim.git OR: gh repo clone nvim-lua/kickstart.nvim

* Run neovim (from terminal or shortcut) and allow the kickstart process to download files and set up the basics.
* Once the setup is complete restart Neovim.
* **You're ready to go!**

* Backup your previous configuration
* (Recommended) Fork this repo (so that you have your own copy that you can modify).
* (Recommended/Optional) Fork this repo (so that you have your own copy that you can modify).
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `~/AppData/Local/nvim/` (Windows)
* If you don't want to include it as a git repo, you can just clone it and then move the files to this location
* Start Neovim (`nvim`) and allow `lazy.nvim` to complete installation.
* Restart Neovim
* **You're ready to go!**

Additional system requirements:
- Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
Expand Down Expand Up @@ -112,7 +129,7 @@ Each PR, especially those which increase the line count, should have a descripti
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
* Are there any cool videos about this plugin?
* Current iteration of kickstart (coming soon)
* Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s).
* Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s). Note the install via init.lua no longer works.
Copy link
Collaborator

@feoh feoh Apr 25, 2023

Choose a reason for hiding this comment

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

I think signposting this video as obsolete is a really good call, but might it be better to just say something like "Note the install instructions here no longer work. Just follow the instructions above instead" or similar?

Copy link
Collaborator

@feoh feoh Apr 25, 2023

Choose a reason for hiding this comment

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

The rest looks good. I'm really concerned that this particular turn of phrase will confuse newcomers. Please consider changing this to just ask folks to follow these instructions instead and I'll merge this in a jiffy :)

Copy link
Collaborator

@feoh feoh Apr 26, 2023

Choose a reason for hiding this comment

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

OK, this is excellent work. I think I'm going to merge and then make that one last wording tweak around the out of date install information in the video myself. Thanks a bunch!


### Windows Installation

Expand Down