The ram module requires initial documentation, both from a user standpoint and a developer standpoint.
A readme should be created similar to other tool readme's in the repo, which explains how a user can use the tool and what all of the arguments mean. As features are added or adjusted, the readme should be kept up-to-date.
More developer documentation should be added, including describing the general approach for constructing the RAM, how the layout class works, Doxygen-style comments on functions, and explanations of any code that might be unintuitive.
The
rammodule requires initial documentation, both from a user standpoint and a developer standpoint.A readme should be created similar to other tool readme's in the repo, which explains how a user can use the tool and what all of the arguments mean. As features are added or adjusted, the readme should be kept up-to-date.
More developer documentation should be added, including describing the general approach for constructing the RAM, how the layout class works, Doxygen-style comments on functions, and explanations of any code that might be unintuitive.