sharpetronics/liboqs
1
0
Fork 0
mirror of https://github.com/open-quantum-safe/liboqs.git synced 2025-10-04 00:02:01 -04:00
Code Issues Projects Releases Wiki Activity

README correction to docs path & additional gitignore to macos + vscode (#1503)

Browse Source 
* 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>
This commit is contained in:
Nigel Jones 2023-07-02 22:02:22 +01:00 committed by GitHub
parent 65adc841c9
commit 93e784725e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.gitignore vendored
View File

@ -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

2
README.md
View File

@ -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.