From c54408d9bde8c230bb91ffb00d8875e59c66145c Mon Sep 17 00:00:00 2001 From: qarlosalberto Date: Wed, 5 Jul 2023 13:31:32 +0200 Subject: [PATCH] chore: add readme, improve ci --- .github/workflows/build_and_release.yml | 8 ++--- README.md | 46 +++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 4 deletions(-) create mode 100644 README.md diff --git a/.github/workflows/build_and_release.yml b/.github/workflows/build_and_release.yml index d363a5f5..08c7060d 100644 --- a/.github/workflows/build_and_release.yml +++ b/.github/workflows/build_and_release.yml @@ -3,9 +3,9 @@ name: Build and release TerosHDL on: push: branches: - - main - dev pull_request: + workflow_dispatch: jobs: ############################################################################## @@ -18,8 +18,8 @@ jobs: - name: Checkout code uses: actions/checkout@v3 - - name: Set version main - if: github.ref == 'refs/heads/main' + - name: Set version stable + if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/dev' run: | PACKAGE_VERSION=$(cat packages/teroshdl/package.json \ | grep version \ @@ -76,7 +76,7 @@ jobs: *.vsix - uses: "marvinpinto/action-automatic-releases@latest" - if: github.ref == 'refs/heads/main' + if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/dev' with: repo_token: "${{ secrets.GITHUB_TOKEN }}" prerelease: false diff --git a/README.md b/README.md new file mode 100644 index 00000000..35c2b592 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +[![Current Version](https://img.shields.io/visual-studio-marketplace/v/teros-technology.teroshdl.png)](https://marketplace.visualstudio.com/items?itemName=teros-technology.teroshdl) +[![Install Count](https://img.shields.io/visual-studio-marketplace/i/teros-technology.teroshdl.png)](https://marketplace.visualstudio.com/items?itemName=teros-technology.teroshdl) +[![Download Count](https://img.shields.io/visual-studio-marketplace/d/teros-technology.teroshdl.png)](https://marketplace.visualstudio.com/items?itemName=teros-technology.teroshdl) +[![vscode-TerosHDL documentation](https://img.shields.io/website.svg?label=vscode-TerosHDL%20Documentation&longCache=true&style=flat-square&url=http%3A%2F%2FTerosTechnology.github.io%2FterosHDLdoc%2Findex.html)](https://TerosTechnology.github.io/terosHDLdoc) + + +![TerosHDL](./packages/teroshdl/resources/images/low_res_banner.png) + +**Check the full documentation:** [https://terostechnology.github.io](https://terostechnology.github.io/) + + +The goal of TerosHDL is to provide an open source IDE for HDL devlopers with functionalities commonly used by software developers. The IDE consist in a bunch of tools and on top of them is the VSCode plugin. Some tools are developed by Teros Technology organization and others come from open source proyects. All the tools are organized in different backends and exposed to the GUI with the plugin. + +The IDE tries to be as much self-contained as possible and simplify the installation process. Features: + +- Simulators and tools support: Vivado, ModelSim, GHDL, Verilator, Icarus, VCS, Yosys, VUnit, cocotb, Diamond, Icestorm, ISE, Quartus, Radiant, Spyglass, Symbiflow, Trellis, Xcelium... and more! +- Go to definition. +- Hover. +- Hiterachy viewer. +- Dependencies viewer. +- Syntax highlighting. +- Template generator. +- Automatic documentation. +- Verilog/SV schematic viewer. +- Errors linter. +- Style linter: Verible. +- Code formatting. +- State machine viewer. +- State machine designer. +- Code snippets and grammar. + +![TerosHDL](./packages/teroshdl/resources/images/gui.gif) + +## Managed by + +- [Carlos Alberto Ruiz](https://www.linkedin.com/in/carlos-alberto-ruiz-fpga/): carlosruiznaranjo@gmail.com +- [Ismael Pérez](https://www.linkedin.com/in/ispero/): ismaelprojo@gmail.com + +## Sponsor + +This project was funded through the NGI Assure Fund, a fund established by NLnet with financial support from +the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, +Content and Technology under grant agreement No 957073. + + +