{"id":17529583,"url":"https://github.com/nullobject/chisel-gcd","last_synced_at":"2025-10-21T07:41:35.767Z","repository":{"id":239866248,"uuid":"800829648","full_name":"nullobject/chisel-gcd","owner":"nullobject","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-15T04:41:42.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-28T04:46:54.035Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nullobject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-15T04:41:25.000Z","updated_at":"2024-05-15T04:41:45.000Z","dependencies_parsed_at":"2024-05-15T21:10:11.313Z","dependency_job_id":"ccb934aa-3777-4635-a1a1-632bd7ffab84","html_url":"https://github.com/nullobject/chisel-gcd","commit_stats":null,"previous_names":["nullobject/chisel-gcd"],"tags_count":0,"template":false,"template_full_name":"chipsalliance/chisel-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullobject%2Fchisel-gcd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullobject%2Fchisel-gcd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullobject%2Fchisel-gcd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nullobject%2Fchisel-gcd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nullobject","download_url":"https://codeload.github.com/nullobject/chisel-gcd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239559833,"owners_count":19659123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-20T16:20:00.637Z","updated_at":"2025-10-21T07:41:30.710Z","avatar_url":"https://github.com/nullobject.png","language":"Scala","readme":"Chisel Project Template\n=======================\n\nYou've done the [Chisel Bootcamp](https://github.com/freechipsproject/chisel-bootcamp), and now you\nare ready to start your own Chisel project.  The following procedure should get you started\nwith a clean running [Chisel3](https://www.chisel-lang.org/) project.\n\n## Make your own Chisel3 project\n\n### Dependencies\n\n#### JDK 8 or newer\n\nWe recommend LTS releases Java 8 and Java 11. You can install the JDK as your operating system recommends, or use the prebuilt binaries from [AdoptOpenJDK](https://adoptopenjdk.net/).\n\n#### SBT or mill\n\nSBT is the most common build tool in the Scala community. You can download it [here](https://www.scala-sbt.org/download.html).  \nmill is another Scala/Java build tool without obscure DSL like SBT. You can download it [here](https://github.com/com-lihaoyi/mill/releases)\n\n#### Verilator\n\nThe test with `svsim` needs Verilator installed.\nSee Verilator installation instructions [here](https://verilator.org/guide/latest/install.html).\n\n### How to get started\n\n#### Create a repository from the template\n\nThis repository is a Github template. You can create your own repository from it by clicking the green `Use this template` in the top right.\nPlease leave `Include all branches` **unchecked**; checking it will pollute the history of your new repository.\nFor more information, see [\"Creating a repository from a template\"](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).\n\n#### Wait for the template cleanup workflow to complete\n\nAfter using the template to create your own blank project, please wait a minute or two for the `Template cleanup` workflow to run which will removes some template-specific stuff from the repository (like the LICENSE).\nRefresh the repository page in your browser until you see a 2nd commit by `actions-user` titled `Template cleanup`.\n\n\n#### Clone your repository\n\nOnce you have created a repository from this template and the `Template cleanup` workflow has completed, you can click the green button to get a link for cloning your repository.\nNote that it is easiest to push to a repository if you set up SSH with Github, please see the [related documentation](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/connecting-to-github-with-ssh). SSH is required for pushing to a Github repository when using two-factor authentication.\n\n```sh\ngit clone git@github.com:nullobject/chisel-gcd.git\ncd chisel-gcd\n```\n\n#### Set project organization and name in build.sbt\n\nThe cleanup workflow will have attempted to provide sensible defaults for `ThisBuild / organization` and `name` in the `build.sbt`.\nFeel free to use your text editor of choice to change them as you see fit.\n\n#### Clean up the README.md file\n\nAgain, use you editor of choice to make the README specific to your project.\n\n#### Add a LICENSE file\n\nIt is important to have a LICENSE for open source (or closed source) code.\nThis template repository has the Unlicense in order to allow users to add any license they want to derivative code.\nThe Unlicense is stripped when creating a repository from this template so that users do not accidentally unlicense their own work.\n\nFor more information about a license, check out the [Github Docs](https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/adding-a-license-to-a-repository).\n\n#### Commit your changes\n```sh\ngit commit -m 'Starting chisel-gcd'\ngit push origin main\n```\n\n### Did it work?\n\nYou should now have a working Chisel3 project.\n\nYou can run the included test with:\n```sh\nsbt test\n```\n\nAlternatively, if you use Mill:\n```sh\nmill chisel-gcd.test\n```\n\nYou should see a whole bunch of output that ends with something like the following lines\n```\n[info] Tests: succeeded 1, failed 0, canceled 0, ignored 0, pending 0\n[info] All tests passed.\n[success] Total time: 5 s, completed Dec 16, 2020 12:18:44 PM\n```\nIf you see the above then...\n\n### It worked!\n\nYou are ready to go. We have a few recommended practices and things to do.\n\n* Use packages and following conventions for [structure](https://www.scala-sbt.org/1.x/docs/Directories.html) and [naming](http://docs.scala-lang.org/style/naming-conventions.html)\n* Package names should be clearly reflected in the testing hierarchy\n* Build tests for all your work\n* Read more about testing in SBT in the [SBT docs](https://www.scala-sbt.org/1.x/docs/Testing.html)\n* This template includes a [test dependency](https://www.scala-sbt.org/1.x/docs/Library-Dependencies.html#Per-configuration+dependencies) on [ScalaTest](https://www.scalatest.org/). This, coupled with `svsim` (included with Chisel) and `verilator`, are a starting point for testing Chisel generators.\n  * You can remove this dependency in the build.sbt file if you want to\n* Change the name of your project in the build.sbt file\n* Change your README.md\n\n## Problems? Questions?\n\nCheck out the [Chisel Users Community](https://www.chisel-lang.org/community.html) page for links to get in contact!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnullobject%2Fchisel-gcd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnullobject%2Fchisel-gcd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnullobject%2Fchisel-gcd/lists"}