Skip to content

Commit

Permalink
docs: simplify the ockam app readme
Browse files Browse the repository at this point in the history
  • Loading branch information
etorreborre committed Dec 22, 2023
1 parent 2991230 commit ab8c0b8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion implementations/swift/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ build_ockam_release:
# build the Portals application in Debug mode
build: build_ockam
# the xcode project expects the ockam executable to be found in the release directory
cp $(ROOT_DIR)/target/debug/ockam $(ROOT_DIR)/target/debug/release
mkdir -p $(ROOT_DIR)/target/release
cp $(ROOT_DIR)/target/debug/ockam $(ROOT_DIR)/target/release
make xcode_build_Debug

# build the Portals application in Release mode
Expand Down
6 changes: 3 additions & 3 deletions implementations/swift/ockam/ockam_app/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Ockam Desktop Application
# Ockam Portals Application


The Ockam Desktop Application is a native MacOS application that provides a GUI for users to interact with Ockam.
It's built on top of on the crate `ockam_app_lib` which exposes C APIs for interacting with Ockam.

## How to build

To build the Ockam Desktop Application:
To build the Ockam Portals Application:
1. Run `make swift_build` from the root of the repository.
2. Launch it using `./implementations/swift/build/Ockam.xcarchive/Products/Applications/Ockam.app/Contents/MacOS/Ockam`
2. Launch it with `make_swift_run` from the root of the repository.

To build the package you can use `make swift_package`.

0 comments on commit ab8c0b8

Please sign in to comment.