Skip to content

Commit 677fef3

Browse files
authored
Replace tutorial with the unified HDL one (#43)
No point in having two tutorials when this is the recommended tooling and everything should be unified. This also updates the main README to point to the getting started in the HDL repo.
1 parent b8884d7 commit 677fef3

35 files changed

+4
-1045
lines changed

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# edg-ide
22

3-
An IDE for the [Polymorphic Blocks board-level HDL](https://github.com/BerkeleyHCI/PolymorphicBlocks) that adds a schematic-like graphical interface (with block diagram visualization) side-by-side with the text editor.
3+
An IDE plugin for the [Polymorphic Blocks board-level HDL](https://github.com/BerkeleyHCI/PolymorphicBlocks) that adds a schematic-like graphical interface (with block diagram visualization) side-by-side with the text editor.
44
Schematic-like actions on the graphical interface (like insert-block or connect-ports) generate into lines of code on the HDL.
55
Direct textual edits to the HDL can also be made at any time, and the block diagram can be updated through a fast incremental recompilation.
66

7-
![IDE Screenshot](docs/ide_blinkyarray_example.png)
7+
![IDE Screenshot](https://raw.githubusercontent.com/BerkeleyHCI/PolymorphicBlocks/master/docs/ide/overview.png)
88

9-
Once you have [the IDE set up](#setup), follow [the getting started tutorial](docs/ide-getting-started.md), which walks through major IDE features and includes an introduction to the HDL.
9+
Check out [the getting started tutorial in PolymorphicBlocks](https://github.com/BerkeleyHCI/PolymorphicBlocks/blob/master/getting-started.md), which introduces the HDL and walks through major IDE features.
1010

1111
For a slightly deeper technical overview, check out our [UIST'21 paper and recorded talks](https://doi.org/10.1145/3472749.3474804).
1212

@@ -21,8 +21,6 @@ Follow the [command-line build instructions](developing.md#build-and-run-from-co
2121
**This project uses submodules**, and may depend on a synchronized version of the `PolymorphicBlocks` submodule.
2222
If you're getting compile errors, try updating submodules with `git submodule update`.
2323

24-
Once the IDE is running, open the Polymorphic Block repository, then continue to [the getting started tutorial](docs/ide-getting-started.md).
25-
2624

2725
## Developing
2826

docs/edg/blinky_model_flat.png

-9.59 KB
Binary file not shown.

docs/edg/blinky_model_full.png

-33.1 KB
Binary file not shown.

docs/edg/blinky_model_hierarchy1.png

-15 KB
Binary file not shown.

docs/edg/blinky_model_hierarchy2.png

-24.3 KB
Binary file not shown.

docs/errors_blinky_unpowered.png

-14.3 KB
Binary file not shown.

docs/footprint_magsense.png

-2.38 KB
Binary file not shown.

docs/gui_set_visualizer_design.png

-73.4 KB
Binary file not shown.

docs/ide-getting-started.md

-924
This file was deleted.

docs/ide_blinkyarray_example.png

-405 KB
Binary file not shown.

docs/ide_library_microcontroller.png

-5.57 KB
Binary file not shown.

docs/ide_pinning.png

-10.9 KB
Binary file not shown.

docs/ide_start.png

-65.4 KB
Binary file not shown.

docs/ide_start_annotated.png

-73.2 KB
Binary file not shown.

docs/ide_visualizer_buckcap.png

-3.87 KB
Binary file not shown.

docs/ide_visualizer_connect_mcu.png

-11.5 KB
Binary file not shown.

docs/ide_visualizer_connected.png

-16.2 KB
Binary file not shown.

docs/ide_visualizer_mcu_preview.png

-7.49 KB
Binary file not shown.

docs/ide_visualizer_overvolt.png

-4.45 KB
Binary file not shown.
-11 KB
Binary file not shown.

docs/intellij_icons/AllIcons.Hierarchy.Subtypes.dark.svg

-1
This file was deleted.

docs/intellij_icons/AllIcons.Hierarchy.Subtypes.svg

-1
This file was deleted.

docs/intellij_icons/AllIcons.Nodes.Folder.svg

-1
This file was deleted.

docs/intellij_icons/PlatformDebuggerImplIcons.MemoryView.Active.dark.svg

-1
This file was deleted.

docs/intellij_icons/PlatformDebuggerImplIcons.MemoryView.Active.svg

-1
This file was deleted.

docs/project.md

-110
This file was deleted.

docs/vis_blinky_array.png

-13 KB
Binary file not shown.

docs/vis_blinky_buck.png

-9.67 KB
Binary file not shown.

docs/vis_blinky_buckabs.png

-9.71 KB
Binary file not shown.

docs/vis_blinky_magsense.png

-14 KB
Binary file not shown.

docs/vis_blinky_powered.png

-8.39 KB
Binary file not shown.

docs/vis_magsense_app.png

-2.93 KB
Binary file not shown.

docs/vis_magsense_device.png

-942 Bytes
Binary file not shown.

docs/vis_nucleo_led.png

-3.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)