Skip to content

Commit

Permalink
Added READMEs; updated packages with URL references
Browse files Browse the repository at this point in the history
  • Loading branch information
Reed Es committed Mar 2, 2023
1 parent 3cfba87 commit 62366fe
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 14 deletions.
7 changes: 1 addition & 6 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,12 @@ let package = Package(name: "DcaltLib",
targets: ["DcaltLib"]),
],
dependencies: [
// .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.4"),
.package(name: "TrackerLib", path: "../TrackerLib"),
// .package(name: "ColorThemeLib", path: "../ColorThemeLib"),
.package(url: "https://github.com/open-trackers/TrackerLib.git", from: "1.0.0"),
],
targets: [
.target(name: "DcaltLib",
dependencies: [
.product(name: "TrackerLib", package: "TrackerLib"),
// .product(name: "ColorThemeLib", package: "ColorThemeLib"),
// .product(name: "Collections", package: "swift-collections"),
],
path: "Sources",
resources: [
Expand All @@ -28,7 +24,6 @@ let package = Package(name: "DcaltLib",
dependencies: [
"DcaltLib",
.product(name: "TrackerLib", package: "TrackerLib"),
// .product(name: "ColorThemeLib", package: "ColorThemeLib"),
],
path: "Tests"),
])
44 changes: 36 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# DcaltLib

A description of this package.
Shared data and business logic layer for the _Daily Calorie Tracker_, presently available as iOS apps and independent watchOS apps.

If there is ever a macOS implementations, it should include this package.

All code licensed with Mozilla Public License 2.0.

## Presets

NOTES ON ADDING/EDITING PRESETS:
### NOTES ON ADDING/EDITING PRESETS:

Corrections are welcome!

All presets are subject to change, including their removal.

MEMBERSHIP QUALIFICATIONS
### MEMBERSHIP QUALIFICATIONS

Presets should be based on foods that can be directly consumed, whether prepared, cooked, or raw.
They should NOT include foods that are typically ingredients to prepared recipes (enriched flour, e.g.).
Expand All @@ -23,7 +26,7 @@ caloric content, so favor the healthier preparations (baked vs fried, e.g.).
Avoid completionism and pedantry! Be practical and focus on the common situtations.
Users with idiosyncratic needs can do their own research to input their desired serving details.

TITLE TEMPLATE FORMATTING
### TITLE TEMPLATE FORMATTING

Template is currently: "Food Name [, Variation] [, qualifier] [([size,] preparation)]"

Expand All @@ -41,18 +44,18 @@ unless otherwise noted. To reduced clutter, do not include "medium", "regular",

preparation: Include preparation notes in parentheses, in lower case.

FUTURE OF TITLE
### FUTURE OF TITLE

Voice support (Siri, e.g.) may be added at some point, and will likely make use of the naming conventions.

The title, now stored as a String, may be further broken up into components.

LOCALIZATION
### LOCALIZATION

Use the US spelling conventions (e.g., "yogurt" vs "yoghurt"). Future localizations can support the alternate
spellings.

SERVING SIZE
### SERVING SIZE

For volume (in mL) and weight (in g) target the typical serving size.

Expand All @@ -64,8 +67,33 @@ considered 30 grams! Try to use accurate metric sources where possible.

Variations of a food (Ground Beef Patty, e.g.) should typically share the same serving size, for comparison.

APP NOTES
### APP NOTES

Preset group names may be different than the default MCategory.title(s) provided in settings and at
app bootstrapping. MCategory(ies) may include multiple preset groups.

## Source Code

* [Open Trackers Website](https://open-trackers.github.io) - website for _Gym Routine Tracker_ and _Daily Calorie Tracker_ apps
* [Open Trackers Project](https://github.com/open-trackers) - Github site for the development project, including full source code

### macOS Apps by the same author

* [FlowAllocator](https://openalloc.github.io/FlowAllocator/index.html) - portfolio rebalancing tool for macOS
* [FlowWorth](https://openalloc.github.io/FlowWorth/index.html) - portfolio valuation and tracking tool for macOS

## License

Copyright 2023 OpenAlloc LLC

All application code is licensed under the [Mozilla Public License 2](https://www.mozilla.org/en-US/MPL/2.0/), except where noted in individual modules.

## Contributing

Contributions are welcome. You are encouraged to submit pull requests to fix bugs, improve documentation, or offer new features.

The pull request need not be a production-ready feature or fix. It can be a draft of proposed changes, or simply a test to show that expected behavior is buggy. Discussion on the pull request can proceed from there.

Contributions should ultimately have adequate test coverage. See tests for current entities to see what coverage is expected.


0 comments on commit 62366fe

Please sign in to comment.