{"id":19290941,"url":"https://github.com/the-openroad-project/openroad_users_read_me_first","last_synced_at":"2025-10-06T13:19:53.580Z","repository":{"id":37443186,"uuid":"235845596","full_name":"The-OpenROAD-Project/OPENROAD_USERS_READ_ME_FIRST","owner":"The-OpenROAD-Project","description":"OpenROAD users should look at this repository first for instructions on getting started","archived":false,"fork":false,"pushed_at":"2021-04-03T02:44:50.000Z","size":26,"stargazers_count":102,"open_issues_count":0,"forks_count":6,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-02-23T23:52:37.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/The-OpenROAD-Project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-23T17:15:03.000Z","updated_at":"2024-11-28T00:50:39.000Z","dependencies_parsed_at":"2022-07-12T13:33:28.466Z","dependency_job_id":null,"html_url":"https://github.com/The-OpenROAD-Project/OPENROAD_USERS_READ_ME_FIRST","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/The-OpenROAD-Project/OPENROAD_USERS_READ_ME_FIRST","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOPENROAD_USERS_READ_ME_FIRST","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOPENROAD_USERS_READ_ME_FIRST/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOPENROAD_USERS_READ_ME_FIRST/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOPENROAD_USERS_READ_ME_FIRST/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-OpenROAD-Project","download_url":"https://codeload.github.com/The-OpenROAD-Project/OPENROAD_USERS_READ_ME_FIRST/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-OpenROAD-Project%2FOPENROAD_USERS_READ_ME_FIRST/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278616447,"owners_count":26016364,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11-09T22:23:06.297Z","updated_at":"2025-10-06T13:19:53.550Z","avatar_url":"https://github.com/The-OpenROAD-Project.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# OPENROAD_USERS_READ_ME_FIRST\nOpenROAD users should look at this repository first for instructions on getting started.\n\nNew users should not try to build the individual repo's from their master branches.\nWith the advent of the [OpenROAD](https://github.com/The-OpenROAD-Project/OpenROAD) unified application, all of the needed code is built directly there.\nThe individual repos' master branches should be considered legacy code.\n\nNew users should start by following the directions in the [OpenROAD-flow-scripts](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts) repo's [flow README](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/README.md).\nThe procedures for the download of prebuilt binaries, building all of the code in a container, and building all of the code on bare metal are described there.\nThe application submodules all point to stable and tested versions of code.\nThe [OpenROAD-flow-scripts](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts) repo also contains open source sample designs on an open source PDK.\nAlong with these designs are Makefiles to run the designs through OpenROAD.\n\nOpenROAD is comprised of a set of repos, however they are all integrated into the top level application repo named [OpenROAD](https://github.com/The-OpenROAD-Project/OpenROAD) except for Yosys and TritonRoute which will be integrated soon.\nAll of the repos that the OpenROAD top level applications needs are set up as sub modules.\nThe top level cmake configuration builds all of them.\nBe sure to clone openroad with the --recursive option to clone all of the submodules in preparation for building.\nIf you follow this procedure and the rest of the instructions as specified in the [application README](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/README.md) you will be able to build the application and all of its submodules.\nKeep in mind that you will need to have the build tools in place that are required for building.\nIf you wish to use docker you can use the image provided here for [Centos7](https://hub.docker.com/r/openroad/centos7-dev) or [Ubuntu 20.04](https://hub.docker.com/r/openroad/ubuntu20-dev) -- to build a local image see `./etc/DockerHelper.sh -help`.\nThe `./etc/DependencyInstaller.sh` [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/etc/DependencyInstaller.sh) script installs the dependencies needed to build the app -- the script supports Centos7 and Ubuntu 20.04 and requires root access.\n\nA architecture [guide](https://openroad.readthedocs.io/en/latest/contrib/OpenroadArch.html) which explains the philosophy behind the code organization and architecture and also describes the workflow for developers to follow is available.\nWorking with submodules in git is non trivial.\nIf you follow the procedures in the section marked Tool Work Flow, you will have a streamlined way to work efficiently.\n\nMore information can be found on our project [website](https://theopenroadproject.org/).\n\nPlease also follow us on [twitter](https://twitter.com/OpenROAD_EDA) to be notified of important project developments.\n\nPlease also \"star\" our project and repos so we know how many people are interested in what we do!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-openroad-project%2Fopenroad_users_read_me_first","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-openroad-project%2Fopenroad_users_read_me_first","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-openroad-project%2Fopenroad_users_read_me_first/lists"}