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.

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

Jump to bottom

Documentation: add some notes about versioning and rework the README a bit #240

Merged
merged 9 commits into from
Oct 4, 2024
Merged

Documentation: add some notes about versioning and rework the README a bit #240

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6c6f0dd
docs: Rework readme and add notes about versioning
wurli Oct 4, 2024
8556878
chore: readme grammar
wurli Oct 4, 2024
527e341
chore: minor readme rewording
wurli Oct 4, 2024
fbdde9a
chore: change some readme header levels
wurli Oct 4, 2024
4b3f6f8
chore: use conventional vim keymapping notation throughout readme
wurli Oct 4, 2024
6917d84
fix: readme typo
wurli Oct 4, 2024
8aff98a
fix: another readme typo
wurli Oct 4, 2024
51bc96e
Update README.md
wurli Oct 4, 2024
ef68600
fix: correct note about <localleader>sp in readme
wurli Oct 4, 2024
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
Prev Previous commit
Next Next commit
chore: readme grammar
  • Loading branch information
@wurli
wurli committed Oct 4, 2024
commit 855687835d4d0a7337318fb0920358769ff789ce
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,15 @@ firm commitment to backwards compatibility.

### Removed features:

- `Rrst` is no longer supported (it no longer seems to be widely used)
- reStructuredText support (it no longer seems to be widely used).

- Debugging support (a debug adaptor would be better)
- Nvim-R's debugging support (a debug adaptor would be better).

- Legacy omni-completion (we now recommend
[nvim-cmp](https://github.com/hrsh7th/nvim-cmp))
[nvim-cmp](https://github.com/hrsh7th/nvim-cmp)).

- Highlighting functions from `.GlobalEnv` (difficult to make compatible with
tree-sitter + LSP highlighting)
tree-sitter + LSP highlighting).

- The `echo` argument for functions that send code to R console has been
removed. Users can still set the `source_args` to define the arguments that
Expand All @@ -164,10 +164,10 @@ firm commitment to backwards compatibility.
### Changes:

- `Alt+-` is now used to insert `<-`. This can be configured using
`assignment_keymap`
`assignment_keymap`.

- `R_source` and `after_R_start` have been replaced with more powerful `hook`
options
options.

- `nvimpager`, which controls how R documentation is displayed, now how possible
options `"split_h"`, `"split_v"`, `"tab"`, `"float"` (not implemented yet),
Expand Down Expand Up @@ -195,27 +195,27 @@ firm commitment to backwards compatibility.

#### New keybindings

- `<LocalLeader>sc` sends a piped chain of commands
- `<LocalLeader>sc` sends a piped chain of commands.

- `<LocalLeader>ip` installs missing packages detected by
[languageserver](https://github.com/REditorSupport/languageserver):
[languageserver](https://github.com/REditorSupport/languageserver).

- `<LocalLeader>sp` splits a filepath under the cursor into individual
components concatenated using `paste()` (requires
[nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) to be
installed)
installed).

- `<LocalLeader>sh` splits a filepath under the cursor into individual
components concatenated using `here::here()` (requires
[nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) to be
installed)
installed).

- `<LocalLeader>,` inserts a pipe operator (`|>`). This is configurable using
`pipe_keymap`
`pipe_keymap`.

#### New options

- `auto_quit` can be configured to automatically quit R when you quit Neovim
- `auto_quit` can be configured to automatically quit R when you quit Neovim.

- `rproj_prioritise` can be configured to control how `.Rproj` files change the
behaviour of R.nvim. Amongst other things, this may affect whether
Expand Down
Loading