Skip to content

Commit

Permalink
Merge pull request #13 from naodeng/main
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
naodeng authored Nov 30, 2023
2 parents 471b0d1 + 2862fa1 commit e95e8b7
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,5 @@ cython_debug/
#.idea/
.idea/
.env/
docs-venv/
site/
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@

## Installation

Create a new python virtualenv
- Create a new python virtualenv

`python3 -m venv docs-venv`

Activate the virtualenv, then
- Activate the virtualenv, then

`pip install mkdocs-material` or `pip install mkdocs-material=="9.*" `
`pip install mkdocs-material` or `pip install mkdocs-material=="9.*"`

Or use the requirements.txt in the root of the project
- Or use the requirements.txt in the root of the project

`pip install -r requirements.txt`
`pip install -r requirements.txt`

- Previewing as you write

`mkdocs serve`

- Building your site

`mkdocs build`
1 change: 1 addition & 0 deletions docs/google5e9a7c9479924ed2.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
google-site-verification: google5e9a7c9479924ed2.html

0 comments on commit e95e8b7

Please sign in to comment.