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 eea5f41 commit fe5bd46
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ let package = Package(name: "TrackerUI",
dependencies: [
.package(url: "https://github.com/openalloc/SwiftCompactor", from: "1.3.0"),
.package(url: "https://github.com/apple/swift-collections.git", from: "1.0.4"),
.package(name: "TrackerLib", path: "../TrackerLib"),
.package(url: "https://github.com/open-trackers/TrackerLib.git", from: "1.0.0"),
],
targets: [
.target(name: "TrackerUI",
Expand Down
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
# TrackerUI

A description of this package.
Shared user interface (UI) layer for the _Gym Routine Tracker_ and _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.

## 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.
2 changes: 1 addition & 1 deletion Sources/AboutView.swift
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ struct AboutView_Previews: PreviewProvider {
privacyURL: url.appending(path: "privacy"),
termsURL: url.appending(path: "terms"),
tutorialURL: url.appending(path: "tutorial"),
copyright: "Copyright 2022, 2023 OpenAlloc LLC", plea: "Blah!"
copyright: "Copyright 2023 OpenAlloc LLC", plea: "Blah!"
) {
Image(systemName: "g.circle.fill")
.imageScale(.large)
Expand Down

0 comments on commit fe5bd46

Please sign in to comment.