Skip to content

Commit

Permalink
README correction to docs path & additional gitignore to macos + vsco…
Browse files Browse the repository at this point in the history
…de (#1503)

* Add .DS_Store (macOS) to .gitignore

Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>

* Correct path to built docs in README

Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>

* Add Visual Studio Code .vscode & Jetbrains .idea to .gitignore

Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>

---------

Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
  • Loading branch information
planetf1 committed Jul 2, 2023
1 parent 65adc84 commit 93e7847
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ tags
# CLion
/cmake-build*

# Visual Studio Code
.vscode

# Jetbrains IDEs
.idea

# MacOS
.DS_Store

# Generated by copy_from_upstream.py
# and update_pqclean_alg_docs.py
scripts/copy_from_upstream/repos
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The following instructions assume we are in `build`.

ninja gen_docs

Then open `docs/doxygen/html/index.html` in your web browser.
Then open `docs/html/index.html` in your web browser.

4. `ninja install` can be run to install the built library and `include` files to a location of choice, which can be specified by passing the `-DCMAKE_INSTALL_PREFIX=<dir>` option to `cmake` at configure time. Alternatively, `ninja package` can be run to create an install package.

Expand Down

0 comments on commit 93e7847

Please sign in to comment.