https://github.com/amaranth-lang/playground

Playground for experimenting with and sharing short Amaranth programs on the web
https://github.com/amaranth-lang/playground

amaranth-hdl

Last synced: about 2 months ago
JSON representation

Playground for experimenting with and sharing short Amaranth programs on the web

• Host: GitHub
• URL: https://github.com/amaranth-lang/playground
• Owner: amaranth-lang
• License: bsd-2-clause
• Created: 2024-02-16T03:20:03.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T01:39:05.000Z (2 months ago)
• Last Synced: 2024-10-30T03:55:24.356Z (2 months ago)
• Topics: amaranth-hdl
• Language: TypeScript
• Homepage: https://amaranth-lang.org/play/
• Size: 12.5 MB
• Stars: 12
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Amaranth Playground

This repository contains the source code for the [Amaranth Playground][], a web application that introduces developers to the [Amaranth HDL][] with zero installation required.

[amaranth playground]: https://amaranth-lang.org/play/

[amaranth hdl]: https://amaranth-lang.org/

## Technical details

This application is built on:

* [TypeScript](https://typescriptlang.org/)

* [React](https://react.dev)

* [MUI (Joy UI)](https://mui.com/joy-ui/getting-started/)

* [Monaco](https://microsoft.github.io/monaco-editor/)

* [d3-wave](https://github.com/Nic30/d3-wave)

* [Pyodide](https://pyodide.org/en/stable/)

* [YoWASP](https://yowasp.org)

* [esbuild](https://esbuild.github.io/)

The amount of dependencies is intentionally kept minimal. All code processing tasks (TypeScript compilation, minification, bundling, polyfilling/transpilation, serving in development) are performed by esbuild, which is amazingly flexible and useful.

## Development

Requires [Node.js](https://nodejs.org/) and  [npm](https://npmjs.org/). Install them and run:

```console

npm install

npm run serve

```

This will start a local server at http://localhost:8010/ (or a subsequent port if this one is in use). Any modifications to the source will cause the application to be reloaded with the modifications applied.

If you are using Visual Studio Code, you can also use Shift+Ctrl+B instead.

## Deployment

The latest commit in the `main` branch is deployed to the `gh-pages` branch, except in the `amaranth-lang/playground` repository. (This lets you show the changes made in your fork to others without them building the application on their machine.)

The latest commit in the `live` branch is deployed to the `main` branch of `amaranth-lang/amaranth-lang.github.io`, which is published at https://amaranth-lang.org/play/. To publish latest changes from the `main` branch, run `git push origin main:live`.

## License

This application is released under the [two-clause BSD license](LICENSE.txt).