Skip to content

Commit

Permalink
fix v check-md ~/.vmodules/vsl
Browse files Browse the repository at this point in the history
  • Loading branch information
spytheman committed Jul 26, 2024
1 parent 702b287 commit f8513d4
Show file tree
Hide file tree
Showing 36 changed files with 101 additions and 49 deletions.
15 changes: 11 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# V Scientific Library - Examples Directory 📚

This directory contains various examples demonstrating the capabilities and usage of the V Scientific Library. Each example showcases different functionalities, from machine learning algorithms to plotting and mathematical computations. Below is a summary of the examples included in this directory:
This directory contains various examples demonstrating the capabilities and usage
of the V Scientific Library. Each example showcases different functionalities,
from machine learning algorithms to plotting and mathematical computations.
Below is a summary of the examples included in this directory:

## Machine Learning Examples 🤖

Expand Down Expand Up @@ -91,7 +94,11 @@ This directory contains various examples demonstrating the capabilities and usag

### Important Information ⚠️

- Each example contains a `main.v` file with the V code demonstrating the specific functionality.
- Some examples include an additional `README.md` file. **You must read the `README.md` before running the example** to understand any prerequisites or specific instructions.
- Each example contains a `main.v` file with the V code demonstrating
the specific functionality.
- Some examples include an additional `README.md` file.
**You must read the `README.md` before running the example** to understand
any prerequisites or specific instructions.

To get started, navigate to the respective example directory and run the `main.v` file using the V compiler.
To get started, navigate to the respective example directory
and run the `main.v` file using the V compiler.
3 changes: 2 additions & 1 deletion examples/deriv_example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - deriv_example 📘

This example demonstrates the usage of the V Scientific Library for demonstrating derivative calculation.
This example demonstrates the usage of the V Scientific Library
for demonstrating derivative calculation.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/dist_histogram/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - dist_histogram 📘

This example demonstrates the usage of the V Scientific Library for creating a distribution histogram.
This example demonstrates the usage of the V Scientific Library
for creating a distribution histogram.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/fft_plot_example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - fft_plot_example 📘

This example demonstrates the usage of the V Scientific Library for demonstrating Fast Fourier Transform (FFT) with plotting.
This example demonstrates the usage of the V Scientific Library
for demonstrating Fast Fourier Transform (FFT) with plotting.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/io_h5_dataset/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - io_h5_dataset 📘

This example demonstrates the usage of the V Scientific Library for demonstrating HDF5 I/O for datasets.
This example demonstrates the usage of the V Scientific Library
for demonstrating HDF5 I/O for datasets.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/io_h5_relax/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - io_h5_relax 📘

This example demonstrates the usage of the V Scientific Library for demonstrating HDF5 I/O for relaxation data.
This example demonstrates the usage of the V Scientific Library
for demonstrating HDF5 I/O for relaxation data.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/iter_lazy_generation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - iter_lazy_generation 📘

This example demonstrates the usage of the V Scientific Library for demonstrating lazy generation using iterators.
This example demonstrates the usage of the V Scientific Library
for demonstrating lazy generation using iterators.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/la_triplet01/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - la_triplet01 📘

This example demonstrates the usage of the V Scientific Library for demonstrating linear algebra operations.
This example demonstrates the usage of the V Scientific Library
for demonstrating linear algebra operations.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_kmeans/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_kmeans 📘

This example demonstrates the usage of the V Scientific Library for demonstrating the K-means clustering algorithm.
This example demonstrates the usage of the V Scientific Library
for demonstrating the K-means clustering algorithm.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_kmeans_plot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_kmeans_plot 📘

This example demonstrates the usage of the V Scientific Library for performing K-means clustering with plotting.
This example demonstrates the usage of the V Scientific Library
for performing K-means clustering with plotting.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_knn_plot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_knn_plot 📘

This example demonstrates the usage of the V Scientific Library for performing K-Nearest Neighbors algorithm with plotting.
This example demonstrates the usage of the V Scientific Library
for performing K-Nearest Neighbors algorithm with plotting.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_linreg01/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_linreg01 📘

This example demonstrates the usage of the V Scientific Library for performing a basic linear regression.
This example demonstrates the usage of the V Scientific Library
for performing a basic linear regression.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_linreg02/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_linreg02 📘

This example demonstrates the usage of the V Scientific Library for performing an advanced linear regression.
This example demonstrates the usage of the V Scientific Library
for performing an advanced linear regression.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_linreg_plot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_linreg_plot 📘

This example demonstrates the usage of the V Scientific Library for performing linear regression with plotting.
This example demonstrates the usage of the V Scientific Library
for performing linear regression with plotting.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/ml_sentiment_analysis/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - ml_sentiment_analysis 📘

This example demonstrates the usage of the V Scientific Library for performing sentiment analysis using machine learning.
This example demonstrates the usage of the V Scientific Library
for performing sentiment analysis using machine learning.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/mpi_basic_example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - mpi_basic_example 📘

This example demonstrates the usage of the V Scientific Library for demonstrating basic MPI functionality.
This example demonstrates the usage of the V Scientific Library
for demonstrating basic MPI functionality.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_heatmap_golden_ratio/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_heatmap_golden_ratio 📘

This example demonstrates the usage of the V Scientific Library for creating a heatmap with the golden ratio.
This example demonstrates the usage of the V Scientific Library
for creating a heatmap with the golden ratio.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_histogram/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_histogram 📘

This example demonstrates the usage of the V Scientific Library for showing how to create a histogram.
This example demonstrates the usage of the V Scientific Library
for showing how to create a histogram.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_line_axis_titles/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_line_axis_titles 📘

This example demonstrates the usage of the V Scientific Library for creating a line plot with axis titles.
This example demonstrates the usage of the V Scientific Library
for creating a line plot with axis titles.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_line_plot_with_areas/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_line_plot_with_areas 📘

This example demonstrates the usage of the V Scientific Library for creating a line plot with shaded areas.
This example demonstrates the usage of the V Scientific Library
for creating a line plot with shaded areas.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_scatter3d_1/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_scatter3d_1 📘

This example demonstrates the usage of the V Scientific Library for creating a 3D scatter plot (example 1).
This example demonstrates the usage of the V Scientific Library for
creating a 3D scatter plot (example 1).

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it following
the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_scatter3d_2/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_scatter3d_2 📘

This example demonstrates the usage of the V Scientific Library for creating a 3D scatter plot (example 2).
This example demonstrates the usage of the V Scientific Library
for creating a 3D scatter plot (example 2).

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_scatter3d_easing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_scatter3d_easing 📘

This example demonstrates the usage of the V Scientific Library for creating a 3D scatter plot with easing.
This example demonstrates the usage of the V Scientific Library
for creating a 3D scatter plot with easing.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_scatter_with_annotations/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_scatter_with_annotations 📘

This example demonstrates the usage of the V Scientific Library for creating a scatter plot with annotations.
This example demonstrates the usage of the V Scientific Library for creating
a scatter plot with annotations.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed.
You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_scatter_with_bars/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_scatter_with_bars 📘

This example demonstrates the usage of the V Scientific Library for creating a scatter plot with bars.
This example demonstrates the usage of the V Scientific Library
for creating a scatter plot with bars.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_scatter_with_histogram/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_scatter_with_histogram 📘

This example demonstrates the usage of the V Scientific Library for creating a scatter plot with histograms.
This example demonstrates the usage of the V Scientific Library
for creating a scatter plot with histograms.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_scatter_with_regression/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_scatter_with_regression 📘

This example demonstrates the usage of the V Scientific Library for creating a scatter plot with regression line.
This example demonstrates the usage of the V Scientific Library
for creating a scatter plot with regression line.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_script_mode_ac_signal/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_script_mode_ac_signal 📘

This example demonstrates the usage of the V Scientific Library for plotting an AC signal in script mode.
This example demonstrates the usage of the V Scientific Library
for plotting an AC signal in script mode.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_script_mode_simple_plot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_script_mode_simple_plot 📘

This example demonstrates the usage of the V Scientific Library for creating a simple plot in script mode.
This example demonstrates the usage of the V Scientific Library
for creating a simple plot in script mode.

## Instructions

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_script_mode_three_phase_signal/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_script_mode_three_phase_signal 📘

This example demonstrates the usage of the V Scientific Library for plotting a three-phase signal in script mode.
This example demonstrates the usage of the V Scientific Library
for plotting a three-phase signal in script mode.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
6 changes: 4 additions & 2 deletions examples/plot_shaded_area_sin/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Example - plot_shaded_area_sin 📘

This example demonstrates the usage of the V Scientific Library for creating a shaded area plot of the sine function.
This example demonstrates the usage of the V Scientific Library
for creating a shaded area plot of the sine function.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
2. Ensure you have the VSL installed. You can do it
following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_sin_cos_surface/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_sin_cos_surface 📘

This example demonstrates the usage of the V Scientific Library for plotting the sine and cosine surface.
This example demonstrates the usage of the V Scientific Library
for plotting the sine and cosine surface.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/plot_surface_easing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - plot_surface_easing 📘

This example demonstrates the usage of the V Scientific Library for plotting a surface with easing functions.
This example demonstrates the usage of the V Scientific Library
for plotting a surface with easing functions.

## Instructions

Expand Down
3 changes: 2 additions & 1 deletion examples/roots_bisection_solver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Example - roots_bisection_solver 📘

This example demonstrates the usage of the V Scientific Library for finding roots using the bisection method.
This example demonstrates the usage of the V Scientific Library
for finding roots using the bisection method.

## Instructions

Expand Down
Loading

0 comments on commit f8513d4

Please sign in to comment.