Skip to content

Commit

Permalink
Update README with more informative platform status
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Dec 1, 2023
1 parent 865c77c commit 32ff425
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,16 @@ Ferrostar is a FOSS navigation SDK built from the ground up for the future.
## Current status

The project is under active development
and the code is not yet ready for use in apps yet.
and the code is not yet ready for use in production yet.
Many parts of the design are still in flux,
so there are no API stability guarantees.

That said, things are now in a solid alpha state on iOS,
and you can actually build a useful, if extremely rough,
proof of concept apps on iOS
You can track the road to something _usable_ in the
[Proof of Concept Milestone](https://github.com/stadiamaps/ferrostar/milestone/1).
That said, things are now in a solid alpha state,
including a minimum usable UI for iOS.
While there are certainly rough edges, it is indeed usable.
See the getting started section below.

We are focusing on iterating on the design with iOS first,
and once we feel we have answered the important design questions,
we can translate the concepts to Android and iterate on the core in parallel.
Android has a theoretically working core, but no UI work has been done.
Our next priority is a first pass of the Android UI.

![A screenshot of the current status](screenshot.png)

Expand Down Expand Up @@ -50,8 +46,6 @@ See the [ARCHITECTURE](ARCHITECTURE.md) document.
See our [CONTRIBUTING](CONTRIBUTING.md) guide
for info on expectations and dev environment setup.

NOTE: The Android project is still in its very early stages; check back soon.

### As a User

#### iOS
Expand All @@ -67,7 +61,8 @@ Coming soon: We're working on the UI components for Jetpack Compose right now!

### Rust

The project should always be developed using the latest stable Rust release. While we don't intend to use every new language features the day it lands,
The project should always be developed using the latest stable Rust release.
While we don't intend to use every new language features the day it lands,
there isn't any reason to lag behind the latest stable.

### Swift
Expand All @@ -85,8 +80,6 @@ extending to two major versions if possible.
### Android

Android developers should always build using the latest publicly available Android Studio version.
Android users are generally much slower to get new OS major versions due to a variety of factors, so
our Android support will initially stretch back to API level 29 (Android 10 / Q). This will similarly cover around 70%
of devices to start.
Android users are generally much slower to get new OS major versions due to a variety of factors.

TODO: Long term, what is a reasonable Android support target? 90%?
TODO: Determine a reasonable Android support target

0 comments on commit 32ff425

Please sign in to comment.