qoherent/ria-toolkit-oss
13
6
Fork 0
Code Issues Pull Requests Workflows Packages Projects Releases 2 Wiki Activity

Adding project logo

Browse Source
This commit is contained in:
Michael Luciuk 2025-09-04 15:09:13 -04:00
parent d807a9f5d5
commit 9f5579de0b
2 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,6 +1,6 @@
<h2 align="center"> <h2 align="center">
<br> <br>
<img src="./docs/source/images/logo.png" alt="RIA Toolkit OSS"> <img src="./docs/images/ria_logo.svg" alt="RIA Toolkit OSS" style="width: 400px; height: auto;">
</h2> </h2>
<h3 align="center">RIA Toolkit OSS, By <a href="https://qoherent.ai/">Qoherent</a></h3> <h3 align="center">RIA Toolkit OSS, By <a href="https://qoherent.ai/">Qoherent</a></h3>
@ -119,12 +119,6 @@ cd ria-toolkit-oss
pip install . pip install .
``` ```
**Note:** If you plan to modify the project code and want changes to take effect immediately without reinstalling, you can install the project in editable mode:
```bash
pip install -e .
```
### Basic usage ### Basic usage
Once the project is installed, you can import its modules, functions, and classes for use in your Python code. For example, you can use the following import statement to access the `Recording` object: Once the project is installed, you can import its modules, functions, and classes for use in your Python code. For example, you can use the following import statement to access the `Recording` object:
@ -202,8 +196,8 @@ When using `sphinx-autobuild`, the docs will automatically be served at http://1
To build the project documentation manually, navigate to the `docs` directory and run the following commands: To build the project documentation manually, navigate to the `docs` directory and run the following commands:
```bash ```bash
make clean poetry run make clean
make html poetry run make html
``` ```
Once the documentation is built, you can view it by opening `docs/build/html/index.html` in a web browser. Please note that this strategy requires manually rebuilding the documentation to view updates. Once the documentation is built, you can view it by opening `docs/build/html/index.html` in a web browser. Please note that this strategy requires manually rebuilding the documentation to view updates.

1
docs/images/ria_logo.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 101 KiB