Merge branch 'main' into hotfix/detailed-using-expressions

Author: yunseopark-kaist

Project.toml

@@ -6,10 +6,8 @@ version = "2.0.1-DEV"
 [deps]
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
-Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 
 [compat]
 CairoMakie = "0.12.18"
 DataFrames = "1.7.0"
-Interpolations = "0.15.1"
 julia = "1.10"

README.md

@@ -1,7 +1,7 @@
 # ParallelPlots
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://moritz155.github.io/ParallelPlots.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://moritz155.github.io/ParallelPlots.jl/dev/)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://moritz155.github.io/ParallelPlots/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://moritz155.github.io/ParallelPlots/dev/)
 [![Build Status](https://github.com/moritz155/ParallelPlots/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/moritz155/ParallelPlots/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/moritz155/ParallelPlots/branch/main/graph/badge.svg)](https://codecov.io/gh/moritz155/ParallelPlots)
 
@@ -10,27 +10,21 @@ This Project is for the TU-Berlin Course "Julia Programming for Machine Learning
 Please make sure, that Julia `1.10` is used!
 
 This Module will return you a nice Scene you can use to display your Data with [Parallel Coordinates](https://en.wikipedia.org/wiki/Parallel_coordinates)<br>
-<img src="test/parallel_coordinates_plot.png" width="300" />
+<img src="test/projectile_simulation.png" width="300" />
 
 _This Module was created with PkgTemplates.jl_
 
 ## Getting Started
 
-### Install Dependencies & Use Package
-Please refer to this [Link](https://adrianhill.de/julia-ml-course/lectures/E1_Installation.html) for Installation of Julia
-
-You need to use the package (1-3) and install the dependencies (4-5)
-1. Open Julia with `julia` in your command prompt
-2. Open the package manager with `]`
-3. Using our Package
-    * `activate /path/to/package` <br>
-      or<br>
-      `activate .` when Julia was opened with command prompt already in package path
-
-    * _you will then see: `(ParallelPlots) pkg>`_
-4. go back to `julia>` by pressing `CMD`+`C`
-5. `Import ParallelPlots` to download Dependencies and use the Package from Command Line
-
+### Install Dependencies & Use ParallelPlots
+#### Script/REPL
+`Pkg> add https://github.com/moritz155/ParallelPlots`
+#### Notebook
+```
+using Pkg
+Pkg.add(url="https://github.com/moritz155/ParallelPlots")
+using ParallelPlots
+```
 ### Usage
 #### Available Parameter
 
@@ -92,23 +86,23 @@ parallelplot(df,
 
 Please read the [Docs](/docs/build/index.html) for further Information
 
-### Working on this Package / Cheatsheet
-1. Using the Package
-   * `activate /path/to/package` <br>
-   or<br>
-   `activate .` when Julia was opened with command prompt already in package path
- 
-   * _you will then see: `(ParallelPlots) pkg>`_
+### Working on ParallelPlots / Cheatsheet
+1. Using ParallelPlots
+    * Moving to the  project folder
+    * `julia --project`
+      * You will see `julia>`
+    * To move to the pkg, type in `]`
+
 
 2. Running commands
    * Adding external Dependencies
-     - `add DepName`
-   * Run Tests to check if Package is still working as intended 
-     - `test`
+     - `(ParallelPlots) pkg>add 'DepName'`
+   * Run Tests to check if ParallelPlots is still working as intended 
+     - `(ParallelPlots) pkg>test`
    * Build
-     - `build`
+     - `(ParallelPlots) pkg>build`
    * Precompile
-     - `precompile`
+     - `(ParallelPlots) pkg>precompile`
 
 
 #### Create Docs