From 1a621cf41d36104d46f22036dc6e6eabf7d7aa31 Mon Sep 17 00:00:00 2001 From: Eren Dogan Date: Fri, 2 Dec 2022 22:34:11 -0800 Subject: [PATCH] Update documentation of library usage --- docs/source/basic_usage.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/source/basic_usage.md b/docs/source/basic_usage.md index 92f33c4c..b9f5f468 100644 --- a/docs/source/basic_usage.md +++ b/docs/source/basic_usage.md @@ -40,19 +40,18 @@ from openram import tech ... ``` -Note that you should need to initalize OpenRAM so that the modules are imported properly. You can also look +Note that you need to initalize OpenRAM so that the modules are imported properly. You can also look at [sram_compiler.py](../../sram_compiler.py) as an example on how to use "openram." -If you want to pass custom configuration when generating an SRAM, you can use `sram_config` class. +If you want to pass custom configuration when generating an SRAM, you can use the `sram_config` class. ```python import openram openram.init_openram("myconfig.py") -openram.setup_bitcell() -from openram.modules import sram_config +from openram import sram_config c = sram_config(...) -from openram.modules import sram +from openram import sram s = sram(sram_config=c, name="custom_name")