diff --git a/README.md b/README.md index aa726588..a67f7381 100644 --- a/README.md +++ b/README.md @@ -52,67 +52,6 @@ It has been observed a potential issue when running Package Manager as an execut For unknown reasons, there is a buildup of "zombie" TCP sockets over time. It is unknown if this is caused by something in Package Manager or ffmpeg/ffprobe. As a remedy/hack, [this script](/scripts/clean-up-tcp-sockets.bat) has been useful to avoid potential longterm issues. -## For Developers - -Be sure to read the [_For Developers_](DEVELOPER.md) documentation. - -Note: This monorepo uses [Yarn](https://yarnpkg.com) and [Lerna](https://github.com/lerna/lerna), so most commands can be run on the root folder (no need to cd into each package). - -### Initialize Repo - -```bash -# install lerna globally -yarn global add lerna - -# set up mono-repo -yarn setup - -# Install all dependencies -yarn - -# Build all packages -yarn build - -``` - -Now you should be good to go. - -Whenever you do a change, run `yarn build` (or `yarn build:changed` to only build the changed ones) to compile. - -Before any code is committed, run these: - -```bash -# Lint all packages -yarn lint - -# Run all tests -yarn test -``` - -### Other Useful Commands - -```bash -# Start the single-app (contains all apps) -yarn start:single-app - -# Start the single-app in local-only mode, using packages from expectedPackages.json -yarn start:single-app -- -- --watchFiles=true --noCore=true --logLevel=debug - - - -# (Windows only) Compile all apps into executables, and put into the deploy/ folder. -yarn do:build-win32 - -# To run a command for a single package, use the --scope option -yarn build --scope @sofie-package-manager/api - -# CLI arguments can be passed like so: (note the double -- --) -yarn start:workforce -- -- --port=8080 - -# Documentation for the CLI agruments -yarn start:workforce -- -- --help - -``` --- _The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._