From 01d7662b5c14e78ae0057b537d3015afe5799f87 Mon Sep 17 00:00:00 2001 From: Caelan Sayler Date: Fri, 5 Jan 2024 10:24:10 +0000 Subject: [PATCH] Test dark/light mode image --- README.md | 44 +++------------------------------ docs/artwork/velopack-black.svg | 37 +++++++++++++++++++++++++++ docs/artwork/velopack-white.svg | 37 +++++++++++++++++++++++++++ docs/compiling.md | 44 +++++++++++++++++++++++++++++++++ docs/readme.md | 0 5 files changed, 122 insertions(+), 40 deletions(-) create mode 100644 docs/artwork/velopack-black.svg create mode 100644 docs/artwork/velopack-white.svg create mode 100644 docs/compiling.md create mode 100644 docs/readme.md diff --git a/README.md b/README.md index 1d293e8a..73c3edb1 100644 --- a/README.md +++ b/README.md @@ -6,44 +6,8 @@ # Velopack -# Compiling + + + Velopack Logo + -Velopack is made up of some Rust binaries which are re-distributed with installed apps, a .NET NuGet package, and a .NET command line tool. In order to test the project, you need to build the Rust binaries before compiling dotnet. - -### Prerequisites - - [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) - - [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) - - [Rust / Cargo](https://www.rust-lang.org/tools/install) - - `dotnet tool install -g dotnet-coverage` - - `dotnet tool install -g nbgv` - -### Debug / Test -On windows, you need to build the Rust binaries using the `windows` feature before running tests. On OSX, you should run `cargo build` instead. - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --features windows -cd ../../ -dotnet build -dotnet test --no-build -``` - -### Release / Build -This is slightly complicated, because you will need to compile Rust on x64 OSX and x64 Windows before creating the final packages. - -On OSX: -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release -``` - -On Windows: -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release --features windows -copy {path_to_osx_update} target/release/updatemac -dotnet build -c Release /p:PackRustAssets=true -``` \ No newline at end of file diff --git a/docs/artwork/velopack-black.svg b/docs/artwork/velopack-black.svg new file mode 100644 index 00000000..cc75f717 --- /dev/null +++ b/docs/artwork/velopack-black.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/artwork/velopack-white.svg b/docs/artwork/velopack-white.svg new file mode 100644 index 00000000..6431d079 --- /dev/null +++ b/docs/artwork/velopack-white.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/compiling.md b/docs/compiling.md new file mode 100644 index 00000000..9a0c93a2 --- /dev/null +++ b/docs/compiling.md @@ -0,0 +1,44 @@ +| [docs](.) / compiling.md | +|:---| + +# Compiling Velopack + +Velopack is made up of some Rust binaries which are re-distributed with installed apps, a .NET NuGet package, and a .NET command line tool. In order to test the project, you need to build the Rust binaries before compiling dotnet. + +### Prerequisites + - [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) + - [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) + - [Rust / Cargo](https://www.rust-lang.org/tools/install) + - `dotnet tool install -g dotnet-coverage` + - `dotnet tool install -g nbgv` + +### Debug / Test +On windows, you need to build the Rust binaries using the `windows` feature before running tests. On OSX, you should run `cargo build` instead. + +```shell +git clone https://github.com/velopack/velopack.git +cd velopack/src/Rust +cargo build --features windows +cd ../../ +dotnet build +dotnet test --no-build +``` + +### Release / Build +This is slightly complicated, because you will need to compile Rust on x64 OSX and x64 Windows before creating the final packages. + +On OSX: +```shell +git clone https://github.com/velopack/velopack.git +cd velopack/src/Rust +cargo build --release +``` + +On Windows: +```shell +git clone https://github.com/velopack/velopack.git +cd velopack/src/Rust +cargo build --release --features windows +copy {path_to_osx_update} target/release/updatemac +dotnet build -c Release /p:PackRustAssets=true +``` \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 00000000..e69de29b