platform icon indicating copy to clipboard operation
platform copied to clipboard

doc: rewrite README.md

Open coolaj86 opened this issue 1 year ago • 1 comments

Re:

  • [x] https://github.com/dashpay/platform/issues/1531
  • [ ] https://github.com/dashpay/platform/issues/1532
  • [ ] https://github.com/dashpay/platform/issues/1533
  • [ ] https://github.com/dashpay/platform/issues/1534
  • [ ] https://github.com/dashpay/platform/issues/1535
  • [ ] https://github.com/dashpay/platform/issues/1536

Preview

See https://github.com/coolaj86/platform/tree/patch-4#table-of-contents

To-Dos

  • [ ] A lot of these command blocks simply need to be moved into scripts:
    ./scripts/prereq-linux-install-deps
    ./scripts/prereq-macos-install-brew-and-llvm
    ./scripts/prereq-macos-install-deps
    ./scripts/install
    
  • [ ] Also need to finish the Table of Contents
  • [ ] Core Packages needs a direct link ./packages#core-packages
  • [ ] Needs "How to Unf***" section for macOS w/ llvm
  • [ ] sudo apt install -y llvm llvm-runtime
  • [ ] Needs 16gb of RAM to build (8gb will fail) + ALL THE CPUs
  • [ ] Command 'protoc-c' not found, but can be installed with:
    npm install --location=global protoc-gen-ts
    ~~sudo apt install protobuf-c-compiler~~
  • [ ] https://github.com/dashpay/platform/issues/1535

I'll work on that once I've verified what set of instructions and scripts are correct.

coolaj86 avatar Oct 26 '23 01:10 coolaj86

Rules:

  • paths should always start with / or ./ so that it's clear to the reader what's a path and what's a command (ex: 'build' vs './build')
  • ENV files should be copied with the correct permissions
corepack enable
yarn install
yarn workspace @dashevo/rs-drive build
yarn workspace @dashevo/wasm-dpp build
yarn workspaces focus --production @dashevo/drive
cp -RPp ./packages/js-drive/.env.example ./packages/js-drive/.env

coolaj86 avatar Oct 26 '23 01:10 coolaj86

@coolaj86 Please reopen PR if you are going to finish it

shumkov avatar Sep 26 '24 18:09 shumkov