diff --git a/README.md b/README.md index e0689aa..3bfe81f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@


- RIA Toolkit OSS + RIA Toolkit OSS

RIA Toolkit OSS, By Qoherent

@@ -119,12 +119,6 @@ cd ria-toolkit-oss 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 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: ```bash -make clean -make html +poetry run make clean +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. diff --git a/docs/images/ria_logo.svg b/docs/images/ria_logo.svg new file mode 100644 index 0000000..ca1cec0 --- /dev/null +++ b/docs/images/ria_logo.svg @@ -0,0 +1 @@ + \ No newline at end of file