VLSIDA / OpenRAM

An open-source static random access memory (SRAM) compiler.
http://www.openram.org
BSD 3-Clause "New" or "Revised" License
780 stars 198 forks source link

Possible minor error on the documentation related with the ROM usage #243

Open PabloUlises opened 1 month ago

PabloUlises commented 1 month ago

Describe the bug

I am not sure, but I think that I have found a minor error on the documentation related with the ROM usage, to be precise under “Command Line Usage”.

In the part where it says:

“ To run macros, it is suggested to use, for example:

cd OpenRAM/macros/rom_configs
make sky130_rom_1kbyte

If I blindly follow what it says, I receive a make error. That seems to be caused by the fact that make file is inside “OpenRAM/macros/” while the configuration is inside “OpenRAM/macros/rom_configs”. Therefore, “make sky130_rom_1kbyte” command works on the “macros” folder but not on the “rom_configs” folder.

I think that it should say:

" To run macros, it is suggested to use, for example:

cd OpenRAM/macros/
make sky130_rom_1kbyte

"

Again, I am not sure if it is an error on the documentation.

Version Which commit are you using? b6a6f12

Additional context https://github.com/VLSIDA/OpenRAM/blob/stable/docs/source/basic_rom_usage.md#go-back