Skip to content

[doc] improve READMEs#6

Merged
stef merged 2 commits into
stef:masterfrom
enjeck:update-readme
Jun 23, 2025
Merged

[doc] improve READMEs#6
stef merged 2 commits into
stef:masterfrom
enjeck:update-readme

Conversation

@enjeck
Copy link
Copy Markdown
Contributor

@enjeck enjeck commented Jun 2, 2025

This PR improves the READMEs for both liboprf and pyoprf

Comment thread README.md
Comment thread python/README.md
Comment thread python/README.md
Comment on lines +129 to +148

```
OSError: liboprf.so.0: cannot open shared object file: No such file or directory
OSError: liboprf-noiseXK.so.0: cannot open shared object file: No such file or directory
```

To fix this, first create symbolic links:

```bash
cd /path/to/liboprf/src
ln -s liboprf.so liboprf.so.0
cd noise_xk
ln -s liboprf-noiseXK.so liboprf-noiseXK.so.0
```

Then when running your Python code, use the LD_LIBRARY_PATH environment variable:

```bash
LD_LIBRARY_PATH=/path/to/liboprf/src:/path/to/liboprf/src/noise_xk python your_script.py
```
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This happened to me on Ubuntu. Maybe there's an easier fix?

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i suppose:

cd /path/to/liboprf/src
sudo PREFIX=/usr make install
ldconfig

or on debian(-derivates) apt install liboprf0t64

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These don't work for me

@stef
Copy link
Copy Markdown
Owner

stef commented Jun 2, 2025

love it! only a few questions that are actually about making the install process less problematic on some systems, but that is my responsibility, it only surfaced during the review. which is more than i expected. many thanks! so useful. <3

@stef
Copy link
Copy Markdown
Owner

stef commented Jun 13, 2025

sorry for the late replies. my mail setup is interrupted by routing issues.

@enjeck
Copy link
Copy Markdown
Contributor Author

enjeck commented Jun 16, 2025

only a few questions that are actually about making the install process less problematic on some systems

I believe the problems on Ubuntu stemmed from not installing libsodium using apt. Maybe we just specify installing with apt and remove the Ubuntu-related troubleshooting?

Comment thread README.md Outdated
@sonarqubecloud
Copy link
Copy Markdown

@stef stef merged commit f531905 into stef:master Jun 23, 2025
1 check passed
@stef
Copy link
Copy Markdown
Owner

stef commented Jun 23, 2025

thank you very much @enjeck i did to small changes to the python readme for the 2 unresolved review comments that remained, i hope you agree with these. for details please see: a7339cd

@enjeck
Copy link
Copy Markdown
Contributor Author

enjeck commented Jun 23, 2025

thank you very much @enjeck i did to small changes to the python readme for the 2 unresolved review comments that remained, i hope you agree with these. for details please see: a7339cd

Great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants