Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance the readme instructions #207

Merged
merged 1 commit into from
Aug 10, 2024
Merged

Enhance the readme instructions #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@
## Compiling from source
Zingo PC is written in Electron/Javascript and can be build from source. It will also automatically compile the Rust SDK needed to run zingo-pc.

#### Pre-Requisites
### Pre-Requisites
You need to have the following software installed before you can build Zingo PC

* [Nodejs (>= 18.0.0) recommended version: v20.9.0 (current) ](https://nodejs.org/en/blog/release/v20.9.0)
* [Yarn](https://yarnpkg.com)
* [Rust stable/nightly version](https://www.rust-lang.org/tools/install)

#### Best Practices to install the NodeJs
It is recommended that you install a version manager instead of just installing NodeJs on you computer.

User Node Version Manager to ensure you can specifically install arbitrary versions across projecs
without losing your mind and polluting your PC with installs.


NOTE: To ensure node 20.9.0 on Arch:
paru -S nvm
And follow "Alternate Installations" for 20.9.0 https://wiki.archlinux.org/title/node.js_ I.E.:
Expand All @@ -18,8 +25,19 @@ And follow "Alternate Installations" for 20.9.0 https://wiki.archlinux.org/title
nvm install 20.9.0
nvm use 20.9.0
```

NOTE2: You have to install `openssl` & `protobuf compiler` as well.


### OpenSSL

This project requires OpenSSL. [Official OpenSSL installation guidelines](https://docs.openssl.org/3.2/man7/ossl-guide-introduction/#getting-and-installing-openssl)


### Protobuf Compiler.

Zingo-PC uses grpc and protocol buffers. See [how to install the protobuf compiler](https://grpc.io/docs/protoc-installation/).


### Building Zingo-PC from source

```
git clone https://github.com/zingolabs/zingo-pc.git
Expand Down