eessppeelllloo/vimix
1
0
Fork 0
mirror of https://github.com/brunoherbelin/vimix.git synced 2025-12-05 15:30:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Make README code easy to copy/paste

Browse Source 
removed the "~$ " that simulated the Bash prompt
This commit is contained in:
Bruno Herbelin
2023-08-29 00:11:36 +02:00
parent 007f7a0ce1
commit 159b778fa9
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -25,18 +25,18 @@ Check the [Quick Installation Guide](https://github.com/brunoherbelin/vimix/wiki
Download and install a released [flatpak package](https://flathub.org/apps/details/io.github.brunoherbelin.Vimix)
~$ flatpak install --user vimix
flatpak install --user vimix
NB: Building your flatpak package is an option for testing the latest beta version from git ; instructions are [here](https://github.com/brunoherbelin/vimix/tree/master/flatpak).
Download and install a released [snap package](https://snapcraft.io/vimix) (slower release frequency)
~$ snap install vimix
snap install vimix
Install the stable debian package (slower release frequency)
~$ sudo apt install vimix
sudo apt install vimix
### Mac OSX
@@ -48,7 +48,7 @@ NB: You'll need to accept the exception in OSX security preference.
## Clone
~$ git clone --recursive https://github.com/brunoherbelin/vimix.git
git clone --recursive https://github.com/brunoherbelin/vimix.git
This will create the directory 'vimix', download the latest version of vimix code,
and (recursively) clone all the internal git dependencies.
@@ -57,10 +57,10 @@ and (recursively) clone all the internal git dependencies.
First time after git clone:
~$ mkdir vimix-build
~$ cd vimix-build
~$ cmake -DCMAKE_BUILD_TYPE=Release ../vimix
~$ cmake --build .
mkdir vimix-build
cd vimix-build
cmake -DCMAKE_BUILD_TYPE=Release ../vimix
cmake --build .
This will create the directory 'vimix-build', configure the program for build, and compile vimix.
If successful, the compilation will have produced the executable `vimix` in the `src` directory.
@@ -68,14 +68,14 @@ You can run vimix with `./src/vimix` :
...
[100%] Built target vimix
~$ ./src/vimix
./src/vimix
## Update clone and re-compile
Run these commands from the `vimix-build` directory if you did 'Clone' and 'Compile' previously and only want to get the latest update and rebuild.
~$ git -C ../vimix/ pull
~$ cmake --build .
git -C ../vimix/ pull
cmake --build .
This will pull the latest commit from git and recompile.
@@ -83,7 +83,7 @@ This will pull the latest commit from git and recompile.
Run this commands from the `vimix-build` directory before runing 'Update clone and re-compile above'
$ git -C ../vimix/ checkout beta
git -C ../vimix/ checkout beta
It should say;
@@ -118,15 +118,15 @@ Optionnal:
#### Ubuntu
~$ apt-get install build-essential cmake libpng-dev libglfw3-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav libicu-dev libgtk-3-dev
apt-get install build-essential cmake libpng-dev libglfw3-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav libicu-dev libgtk-3-dev
Optionnal:
~$ apt-get install libglm-dev libstb-dev libtinyxml2-dev ableton-link-dev
apt-get install libglm-dev libstb-dev libtinyxml2-dev ableton-link-dev
+ Follow the instructions to [install Shmdata](https://gitlab.com/sat-mtl/tools/shmdata).
#### OSX with Brew
~$ brew install cmake libpng glfw gstreamer gst-libav gst-plugins-bad gst-plugins-base gst-plugins-good gst-plugins-ugly icu4c
brew install cmake libpng glfw gstreamer gst-libav gst-plugins-bad gst-plugins-base gst-plugins-good gst-plugins-ugly icu4c