Skip to content

Commit

Permalink
wip docs + conan
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffmur committed Sep 9, 2024
1 parent 3f209be commit ae18ed6
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
- name: Compile
env:
ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path || '' }}
ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}
id: compile
run: |
source .venv/bin/activate
Expand Down
18 changes: 0 additions & 18 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,6 @@ build-cmake:
.PHONY: build
build: trust-project build-cmake

# Release helper
.PHONY: dist-cmake
dist-cmake: export UNIT_TEST ?= OFF
dist-cmake: export TARGET_DIR ?= $(FHE_RELEASE_DIR)
dist-cmake:
@make build-cmake

.PHONY: dist
dist: dist-cmake

.PHONY: dist-ci
dist-ci: OUTPUT_FILE ?= libfhel-$(OS)-$(ARCH).tar.gz
dist-ci: OUTPUT_PATH ?= $(FHE_RELEASE_DIR)/$(OUTPUT_FILE)
dist-ci: dist-cmake
@ls -d $(FHE_RELEASE_DIR)/libfhel* | grep -o '[^/]*$$' | tar -czvf $(OUTPUT_PATH) -C $(FHE_RELEASE_DIR) --files-from=-
@echo "tar_gz_name=$(OUTPUT_FILE)" >> $(GITHUB_OUTPUT)
@echo "tar_gz_path=$(OUTPUT_PATH)" >> $(GITHUB_OUTPUT)

# Generate html dart api docs
.PHONY: docs
docs:
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,15 @@ dart pub publish
```

In the future, we may configure an [automated](https://dart.dev/tools/pub/automated-publishing) publishing.

## Distribution 📦

For distribution, we use [Conan](https://conan.io/) to manage C++ dependencies, wrapped with [Poetry](https://python-poetry.org/) to be run in a virtual environment.

From the root of the project:
```bash
pip install poetry
poetry config virtualenvs.create true
poetry install
conan create .
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ build-backend = "poetry.core.masonry.api"
# For IDE to recognize the venv
[tool.pyright]
venvPath = "."
venv = "venv"
venv = ".venv"

0 comments on commit ae18ed6

Please sign in to comment.