-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update README and metadata for VSCode Workspaces extension
- Loading branch information
1 parent
4301c7a
commit 7e2efed
Showing
3 changed files
with
40 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,25 @@ | ||
# VSCode Nautilus Extension | ||
|
||
 | ||
<!-- [](https://github.com/ZanzyTHEbar/vscode-nautilus/actions/workflows/eslint.yml) --> | ||
 | ||
<!-- [](https://github.com/ZanzyTHEbar/vscode-workspaces/actions/workflows/eslint.yml) --> | ||
 | ||
|
||
## Description | ||
|
||
<!--  --> | ||
|
||
VSCode Nautilus Extension is a project that provides a GNOME Shell extension for accessing visual studio code/codium recently opened workspaces/directories. | ||
VSCode Workspaces is a project that provides a GNOME Shell extension for accessing visual studio code/codium recently opened workspaces/directories. | ||
|
||
With workspace support, you can open a workspace in Visual Studio Code with a single click. | ||
|
||
Provided are two other, optional, extensions for Nautilus. | ||
|
||
The first, `vscode_nautilus_workspaces.py`, adds a right-click context menu to select from a list of recently accessed workspaces or directories and open in Visual Studio Code. | ||
|
||
The second, `vscode_nautilus_open.py`, adds a right-click context menu to open a folder or file in Visual Studio Code. | ||
|
||
## Features | ||
|
||
- Supports GNOME Shell 45 - 46 | ||
- Supports GNOME Shell 45+ | ||
- List all your local VSCode workspaces | ||
- List all your remote VSCode projects | ||
- Add a custom workspace by path | ||
- Supports both Visual Studio Code and Codium | ||
- Nautilus extensions for opening folders and files in Visual Studio Code | ||
- Optional Nautilus extensions for opening folders and files in Visual Studio Code | ||
|
||
## Install Extension | ||
|
||
|
@@ -36,10 +30,20 @@ The second, `vscode_nautilus_open.py`, adds a right-click context menu to open a | |
### Install from Source | ||
|
||
```bash | ||
bash <(wget -qO- https://raw.githubusercontent.com/ZanzyTHEbar/vscode-nautilus/main/install.sh) | ||
bash <(wget -qO- https://raw.githubusercontent.com/ZanzyTHEbar/vscode-workspaces/main/install.sh) | ||
``` | ||
|
||
## Uninstall GNOME Shell Extension | ||
## Usage | ||
|
||
### GNOME Shell Extension | ||
|
||
To open a recent folder or workspace, click on the Visual Studio Code icon in the top bar and select a recent folder or workspace. | ||
|
||
You also have various options to configure the extension in the GNOME Tweaks application. | ||
|
||
Integrates well with the [VSCode Search Provider](https://extensions.gnome.org/extension/6976/vscode-search-provider/). | ||
|
||
#### Uninstall GNOME Shell Extension | ||
|
||
To uninstall a GNOME Shell extension, you can use the GNOME Tweaks application or the `gnome-extensions` command. | ||
|
||
|
@@ -54,28 +58,24 @@ You can also remove the directory manually. | |
rm -rf ~/.local/share/gnome-shell/extensions/[email protected] | ||
``` | ||
|
||
## Uninstall Nautilus Extensions | ||
### Nautilus Extensions | ||
|
||
```bash | ||
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_workspaces.py | ||
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_open.py | ||
``` | ||
Provided are two other, optional, extensions for Nautilus. | ||
|
||
## Usage | ||
The first, `vscode_nautilus_workspaces.py`, adds a right-click context menu to select from a list of recently accessed workspaces or directories and open in Visual Studio Code. | ||
|
||
### Nautilus Extensions | ||
The second, `vscode_nautilus_open.py`, adds a right-click context menu to open a folder or file in Visual Studio Code. | ||
|
||
To open a folder or file in Visual Studio Code, right-click on an item in Nautilus and select the "Open in Code" option. | ||
|
||
To open a recent folder or workspace, right-click on an empty space in Nautilus and select the "Open Recent Workspaces" option. | ||
|
||
### GNOME Shell Extension | ||
|
||
To open a recent folder or workspace, click on the Visual Studio Code icon in the top bar and select a recent folder or workspace. | ||
#### Uninstall Nautilus Extensions | ||
|
||
You also have various options to configure the extension in the GNOME Tweaks application. | ||
|
||
Integrates well with the [VSCode Search Provider](https://extensions.gnome.org/extension/6976/vscode-search-provider/). | ||
```bash | ||
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_workspaces.py | ||
rm -f ~/.local/share/nautilus-python/extensions/vscode_nautilus_open.py | ||
``` | ||
|
||
## Development | ||
|
||
|
@@ -88,8 +88,8 @@ Navigate to your desired directory and execute following commands in the termina | |
### GNOME 45+ | ||
|
||
```bash | ||
git clone https://github.com/ZanzyTHEbar/vscode-nautilus.git | ||
cd vscode-nautilus/gnome-extension | ||
git clone https://github.com/ZanzyTHEbar/vscode-workspaces.git | ||
cd vscode-workspaces/gnome-extension | ||
|
||
make && make pack && make install | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,10 +2,16 @@ | |
"name": "VSCode Workspaces", | ||
"description": "A VSCode/Codium Workspace management tool-set for GNOME - This extension is not affiliated, funded, or in any way associated with Microsoft and vscode software.", | ||
"uuid": "[email protected]", | ||
"url": "https://github.com/ZanzyTHEbar/vscode-nautilus", | ||
"url": "https://github.com/ZanzyTHEbar/vscode-workspaces", | ||
"settings-schema": "org.gnome.shell.extensions.vscode-workspaces", | ||
"shell-version": ["45", "46", "47"], | ||
"shell-version": [ | ||
"45", | ||
"46", | ||
"47", | ||
"48", | ||
"49" | ||
], | ||
"donations": { | ||
"github": "ZanzyTHEbar" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters