diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..a616492 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +2.7.18 diff --git a/README.md b/README.md index a00db7b..3fa0ca4 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,17 @@ Optionally you can use the `--port` argument to specify a HTTP port (defaults to ## Development This Silver Bullet repo is a monorepo using npm's "workspaces" feature. -Requirements: node 16+ and npm 8+ as well as C/C++ compilers (for compiling SQLite, on debian/ubuntu style systems you get these via the `build-essential` package) +Requirements: +- node 18+ and npm 8+ +- C/C++ compilers (for compiling SQLite, on debian/ubuntu style systems you get these via the `build-essential` package) +- python v2.7 + +> **Note** +> If you use nvm, you can just `nvm install` and it should use the right version + +> **Note** +> On MacOs Monterey, python v2.7 is no longer shipped, if you install pyenv, you can `pyenv install` and it should use the right version + To run, after clone: @@ -81,7 +91,7 @@ Run these in separate terminals # Runs ParcelJS in watch mode, rebuilding the server and webapp continuously on change npm run watch # Runs the silverbullet server -npm run server +npm run server -- # Builds (and watches for changes) all builtin plugs (in packages/plugs) -npm run plugs -- +npm run plugs ```