Skip to content

Commit 0d4ab11

Browse files
authored
Update README after building for MacOS (#1605)
Some README additions to FW Lite and the OSX README
1 parent 9832c18 commit 0d4ab11

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
[![Staging workflow](https://github.com/sillsdev/languageforge-lexbox/actions/workflows/lexbox-api.yaml/badge.svg?branch=develop)](https://github.com/sillsdev/languageforge-lexbox/actions/workflows/lexbox-api.yaml?query=branch%3Adevelop)
22

33
# Lexbox (formerly Language Depot)
4+
Looking for [FieldWorks Lite](backend/FwLite/README.md)?
45

56
## Repo Structure
67

78
* [backend](backend/README.md) - dotnet API
8-
* [backend/FwLite](backend/FwLite/README.md) - FieldWorks lite application
9+
* [backend/FwLite](backend/FwLite/README.md) - FieldWorks Lite application
910
* [frontend](frontend/README.md) - SvelteKit app
1011
* hgweb - hgweb Dockerfile and config
1112
* otel - Open Telemetry collector config
@@ -29,6 +30,7 @@ Summary of setup steps below. See the appropriate file for your operating system
2930

3031
### Setup
3132
* install [Taskfile](https://taskfile.dev/installation/)
33+
* optionally install [Kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/)
3234
* install [Tilt](https://docs.tilt.dev/) and add it to your path (don't forget to read the script before running it)
3335
* run `tilt version` to check that Tilt is installed correctly
3436
* clone the repo

backend/FwLite/README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,33 @@
1010
* linux: `sudo snap install task --classic` or other options on their website
1111
* mac: `brew install go-task/tap/go-task`
1212
* via npm: `npm install -g @go-task/cli`
13+
* .Net Maui workload
14+
```bash
15+
sudo dotnet workload restore
16+
```
17+
* XCode (for MacOS and iOS)
18+
* Android SDK API 35+ (can be installed via Android Studio)
19+
* Java SDK 17 (for Android)
1320

14-
### Running the project
21+
### Running FWLite Web
1522

16-
from repo root you will be able to develop the UI as well. From this folder it will just run the backend and use the most recent built of the frontend for the UI.
23+
from repo root you will be able to develop the UI as well. From this folder it will just run the backend and use the most recent build of the frontend for the UI.
1724
```bash
1825
task web-for-develop
1926
```
2027

28+
### Running Tests
29+
For .Net tests, you can run them from the command line, in the repo root:
30+
```bash
31+
dotnet test FwLiteOnly.slnf
32+
```
33+
34+
### Building for a specific framework
35+
```bash
36+
dotnet build -f net9.0-ios
37+
```
38+
You can choose which framework to build for with the `-f` flag.
39+
2140
## High level project flow diagram
2241

2342
```mermaid

docs/DEVELOPER-osx.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
### Prerequisites
2-
* docker and compose
3-
* enable Kubernetes in the Docker Desktop settings
4-
5-
### Setup details
6-
* install [Taskfile](https://taskfile.dev/installation/)
7-
* `brew install go-task/tap/go-task` should do it
8-
* Or via npm: `npm install -g @go-task/cli`
9-
10-
None of the current Lexbox developers use OS X, so the above is likely incomplete. If there is anything missing in these setup details, please [open a PR](https://github.com/sillsdev/languageforge-lexbox/pulls) to fill in the missing steps.
1+
### MacOS specific requirements
2+
* Install ICU4c (MacOS does not have ICU installed by default)
3+
* `brew install icu4c`
4+
* Add the following lines to your ~/.zshrc (Apple Silicon)
5+
```
6+
export DYLD_LIBRARY_PATH=/opt/homebrew/opt/icu4c/lib:$DYLD_LIBRARY_PATH
7+
export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=false
8+
```

0 commit comments

Comments
 (0)