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

more documentation updates #774

Merged
merged 1 commit into from
Oct 6, 2023
Merged

more documentation updates #774

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ Node packages will be in `.tgz` files located at:
/packages/client/omega-edit-node-client-${VERSION}.tgz
```

More information about the node packages can be found in the [packages](packages/README.md) folder.

## Release Binaries

[Binary releases](https://github.com/ctc-oss/omega-edit/releases) for macOS (Apple Silicon and x86), Windows (x86), and
Expand Down
10 changes: 6 additions & 4 deletions packages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Ωedit™ Node Packages

:exclamation: These commands should be executed in the `packages` folder after a successful [build](../README.md). :exclamation:

This folder contains different node packages that will be created for `omega-edit`. These packages are:

* `@omega-edit/server` - The server package for `omega-edit`
Expand All @@ -13,8 +15,8 @@ local `node_modules` folder in the project that has Ωedit™ dependencies. Her
1. In the packages folder, run `yarn link`.

```bash
pushd packages/server && yarn link && popd
pushd packages/client && yarn link && popd
yarn --cwd server link
yarn --cwd client link
```

2. In the project folder that you want to use the packages in, run `yarn link <package-name>`. If the project uses npm,
Expand All @@ -36,6 +38,6 @@ yarn unlink @omega-edit/server @omega-edit/client
5. You can also unlink the packages from the package folder by running `yarn unlink` in the package folder.

```bash
pushd packages/server && yarn unlink && popd
pushd packages/client && yarn unlink && popd
yarn --cwd server unlink
yarn --cwd client unlink
```
2 changes: 1 addition & 1 deletion packages/client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@omega-edit/client",
"version": "0.9.74",
"description": "OmegaEdit gRPC Client TypeScript Types",
"description": "OmegaEdit gRPC Client",
"publisher": "ctc-oss",
"main": "out/index.js",
"types": "out/index.d.ts",
Expand Down
32 changes: 0 additions & 32 deletions packages/client/src/dataMan.ts
View file
Open in desktop

This file was deleted.

36 changes: 0 additions & 36 deletions packages/client/tests/specs/dataMan.spec.ts
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion packages/server/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@omega-edit/server",
"version": "0.9.74",
"description": "OmegaEdit gRPC Server TypeScript functions",
"description": "OmegaEdit gRPC Server",
"publisher": "ctc-oss",
"main": "out/index.js",
"types": "out/index.d.ts",
Expand Down