issues
search
ORNL
/
intersect-architecture
https://intersect-architecture.readthedocs.io
Creative Commons Attribution 4.0 International
2
stars
0
forks
source link
small whitespace changes to README
#9
Closed
naughtont3
closed
1 month ago
engelmannc
commented
1 month ago
You may want to fix the "Building Docs Manually" section:
Rename the section to "Building the Documentation Manually"
Line up the shell commands vertically (use ```bash. ''', see below)
Maybe add "pip install pip --upgrade" after activation in Step 1
Maybe add "git clone --single-branch --branch main
https://github.com/ORNL/intersect-architecture.git
" to Step 1
Maybe use "
bash
" for the shell segments and drop the shell prompt, see
https://www.thecodebuzz.com/highlight-bash-shell-code-in-markdown-readme-md-wiki-files/
You may want to fix the "Building Docs Manually" section:
bash" for the shell segments and drop the shell prompt, see https://www.thecodebuzz.com/highlight-bash-shell-code-in-markdown-readme-md-wiki-files/