Skip to content

Commit

Permalink
Format the rest of our markdown
Browse files Browse the repository at this point in the history
Summary:
Stacked the next diff on top and ran

```
arc lint --take PRETTIERMARKDOWN --paths-cmd 'find . -type f -name "*.md" -print' -a
```

Reviewed By: zertosh

Differential Revision: D53590286

fbshipit-source-id: 52cad14893ef6894e36646a1de22f1da55e6f58d
  • Loading branch information
JakobDegen authored and facebook-github-bot committed Feb 8, 2024
1 parent 5f1b407 commit 8254a5c
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 18 deletions.
15 changes: 9 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

## 0.2.0 (June 5, 2023)

The major change from the last release is that `State` has been deleted in favor of `render` taking a reference to the components. In addition there were a number of API adjustments, including:
The major change from the last release is that `State` has been deleted in favor
of `render` taking a reference to the components. In addition there were a
number of API adjustments, including:

* Add the type `Lines` wrapping `Vec<Line>`.
* Add `Span::new_colored` and `Span::new_colored_lossy`.
* Remove the `line!` macro and add more utilities to the `Line` type, making its internals private.
* Rename `x`/`y` to `width`/`height` where it makes sense.
- Add the type `Lines` wrapping `Vec<Line>`.
- Add `Span::new_colored` and `Span::new_colored_lossy`.
- Remove the `line!` macro and add more utilities to the `Line` type, making its
internals private.
- Rename `x`/`y` to `width`/`height` where it makes sense.

## 0.1.0 (February 3, 2022)

* Initial version.
- Initial version.
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Contributing to Superconsole

We want to make contributing to this project as easy and transparent as possible.
We want to make contributing to this project as easy and transparent as
possible.

## Our Development Process

Superconsole is currently developed in Facebook's internal repositories and then exported
out to GitHub by a Facebook team member; however, we invite you to submit pull
requests as described below.
Superconsole is currently developed in Facebook's internal repositories and then
exported out to GitHub by a Facebook team member; however, we invite you to
submit pull requests as described below.

## Pull Requests

Expand Down Expand Up @@ -42,5 +43,6 @@ Follow the automatic `rust fmt` configuration.
## License

By contributing to Superconsole, you agree that your contributions will be
licensed under both the [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE)
files in the root directory of this source tree.
licensed under both the [LICENSE-MIT](LICENSE-MIT) and
[LICENSE-APACHE](LICENSE-APACHE) files in the root directory of this source
tree.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# A component-based framework for building Rust Text-based User Interfaces (TUIs)

There are several copies of this repo on GitHub, [facebookincubator/superconsole](https://github.com/facebookincubator/superconsole) is the canonical one.
There are several copies of this repo on GitHub,
[facebookincubator/superconsole](https://github.com/facebookincubator/superconsole)
is the canonical one.

The superconsole framework provides a powerful line based abstraction over text based rendering to the terminal. It also provides basic building blocks like line manipulation, and a higher level of composable components. A base set of "batteries" components are included to help developers create Text-based User Interfaces (TUIs) as quickly as possible.
The superconsole framework provides a powerful line based abstraction over text
based rendering to the terminal. It also provides basic building blocks like
line manipulation, and a higher level of composable components. A base set of
"batteries" components are included to help developers create Text-based User
Interfaces (TUIs) as quickly as possible.

The design choices that underly superconsole are selected to prioritize testability, ease of composition, and flexibility.
The design choices that underly superconsole are selected to prioritize
testability, ease of composition, and flexibility.

Superconsole also offers stylization, including italics, underlining, bolding, and coloring text. Furthermore, relying on crossterm ensures that it is compatible with Windows, Unix, and MacOS.
Superconsole also offers stylization, including italics, underlining, bolding,
and coloring text. Furthermore, relying on crossterm ensures that it is
compatible with Windows, Unix, and MacOS.

Finally, superconsole delineates between rendering logic and program state - each render call accepts an immutable reference to state, which components may use to inject state into their otherwise immutable rendering logic.
Finally, superconsole delineates between rendering logic and program state -
each render call accepts an immutable reference to state, which components may
use to inject state into their otherwise immutable rendering logic.

## Demo

Expand Down Expand Up @@ -46,4 +57,5 @@ See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.

## License

Superconsole is both MIT and Apache License, Version 2.0 licensed, as found in the [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) files.
Superconsole is both MIT and Apache License, Version 2.0 licensed, as found in
the [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) files.

0 comments on commit 8254a5c

Please sign in to comment.