Skip to content

Update readme #21

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 1 commit into from
Oct 23, 2024
Merged

Update readme #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ dist
node_modules
.vscode-test/
*.vsix
*.code-workspace
34 changes: 10 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,22 @@ The resulting workflow looks like Grant's 🥳
<iframe width="560" height="315" src="https://www.youtube.com/embed/VaNHlFh0r5E?si=ClVdBSI1k_-mzKFr" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>


**Recommended keyboard bindings**:
- `checkpoint_paste` :: `cmd+' cmd+r`

## Todo
- [X] Support `checkpoint_paste()` for interactive development
- [ ] Port Grant's other sublime plugins from [this repo](https://github.com/3b1b/videos/tree/bfa09d02afa9b802004525a86592162021afede9/sublime_custom_commands) (i.e., manim_exit, manim_recorded_checkpoint_paste, manim_run_scene, manim_skipped_checkpoint_paste, open_mirrored_directory), as useful
**Default keyboard bindings**:
- `cmd+' cmd+r` :: Run the `checkpoint_paste()` command from 3b1b's manim library on the highlighted code lines (`manim-notebook.previewSelection`)
- `cmd+' cmd+e` :: Execute all lines of the active manim cell interactively (`manim-notebook.previewManimCell`)

## Local Development

(mostly for my own future reference)

Make changes to `src/extension.ts` then

```
npm run compile
vsce package # `npm i -g vsce` if not already installed
```

Install locally:
cmd+shift+p > "Extensions: Install from VSIX"
Prerequisite: install `vsce` (`npm i -g vsce`)

<br />

---
**Install locally**

Alternative:
After making changes:

- set version in `package.json`
- `cd` to the extension root dir -> `vsce package` (select `y`) -> a `.vsix` file will be created
- `cmd+shift+p` -> "Extensions: Install from VSIX" -> select this file -> reload window and terminal
1. Bump the version in `package.json`
2. `vsce package` (select `y`; a `.vsix` file will be created)
3. `cmd+shift+p` > "Extensions: Install from VSIX" > select the `.vsix` file
4. reload window

<br />

Expand Down