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.

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

doc: rewrite README.md #1530

Open
wants to merge 2 commits into
base: v1.0-dev
Choose a base branch
from
Open

doc: rewrite README.md #1530

wants to merge 2 commits into from

Conversation

coolaj86
Copy link

@coolaj86 coolaj86 commented Oct 26, 2023

Re:

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
  • yarn setup fails exit 1 for dapi-grpc #1535

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

@coolaj86
Copy link
Author

coolaj86 commented Oct 26, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant