Skip to content

Commit

Permalink
Update readme noting improved quality level and updated directory str…
Browse files Browse the repository at this point in the history
…ucture
  • Loading branch information
nazar-pc authored Sep 9, 2024
1 parent 6851f49 commit 1188c88
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Space Acres is an opinionated GUI application for farming on [Autonomys Network]

## Current status

Current status of the project is Alpha.
Current status of the project is Beta.

This means that while it should generally work, expect things to not work sometimes, break in unexpected ways and error
handling to be lacking.
This means that it should generally work, most happy paths and edge cases are handled, many error cases have reasonable
recovery options, etc.

Current version supports Gemini 3h chain only and doesn't allow to select anything else. It supports upgrading existing
installations from 3g.
Expand Down Expand Up @@ -43,14 +43,16 @@ The project at high level is structured in a few large modules:
that abstracts away its internals
* `node` contains consensus node with a wrapper data structure that abstracts away its internals
* `utils` contains some low-level utilities
* `docs` contains documentation files
* `frontend` handles majority of frontend logic with each module corresponding to a major application screen/view
* `frontend` handles majority of frontend logic with each module corresponding to a major application screen/view or
feature
* `res` contains various non-code resources required for application operation and/or packaging
* `app.css` contains a few small non-critical tweaks for presentation, it will likely be necessary to ship a GTK4
theme with the app in the future to ensure consistent look
* `linux` contains Linux-specific resources
* `macos` contains macOS-specific resources
* `translations` contains translations to various languages
* `windows` contains Windows-specific resources
* `main.rs` handles high-level UI and communication with backend, wiring everything together
* `main.rs` handles CLI, instantiates frontend and backend, wiring everything together

Application supports bare minimum configuration and doesn't support operator functionality (not yet anyway).

Expand Down

0 comments on commit 1188c88

Please sign in to comment.