From 00f554819e60a6b25c9dc7fc4fea79a643911ed8 Mon Sep 17 00:00:00 2001 From: dimkauzh Date: Tue, 23 Jan 2024 18:37:07 +0100 Subject: [PATCH] Update docs --- README.md | 32 +++++++++----------------------- docs/index.md | 4 +++- 2 files changed, 12 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2d31278..492977a 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ PyPI - License PyPI - Status PyPI - Downloads -GitHub contributors -Lines of code +GitHub contributors +Lines of code

@@ -49,30 +49,16 @@ if you want to install the package from source and get the latest changes then y ``` ### 🏃‍♂️ Run example -The examples are located [here](https://github.com/dimkauzh/fusion-engine/tree/main/src/fusionengine/examples) +The examples are located [here](https://github.com/fusionengine-org/fusion-engine/tree/main/src/fusionengine/examples) If you want to run the example, then follow these instructions: -#### 🆕 Fusion engine v4.2.1 and later -First, make sure you have fusion engine installed. Then you can run the first example with the following command: +1. First, make sure you have fusion engine installed. +2. If fusion engine is installed, you can run the first example with the following command: ```bash python -m fusionengine.examples.example1 ``` For other examples, you can modify the command to run the other example. Just change the number of the example. -#### 🧓 Fusion engine v4.2.0 and earlier -You will need to clone the Fusion engine repo to run the exampes. To do that run this command: -```bash - git clone https://github.com/dimkauzh/fusion-engine.git - cd fusion-engine -``` - -Then you can run the example with the following command: -```bash - python src/fusionengine/examples/example1.py -``` - -For different examples, you change the number to the number of the example file - ## 👥 Community We have a discord server at this [link](). @@ -104,11 +90,11 @@ This project began May 1, 2023. The original project began in C, but it's entire ### ⭐ Star History - + - - - Star History Chart + + + Star History Chart diff --git a/docs/index.md b/docs/index.md index fe2d259..039ca64 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,13 +8,15 @@ hide: logo

+

PyPI PyPI - Python Version PyPI - License PyPI - Status PyPI - Downloads -GitHub contributors +GitHub contributors +Lines of code