mirror of
https://github.com/FliegendeWurst/cursive.git
synced 2024-11-12 20:23:35 +00:00
Rename repo name to use lowercase
This commit is contained in:
parent
874eb95690
commit
0c8a7b2708
@ -8,15 +8,15 @@ keywords = ["ncurses", "TUI", "UI"]
|
|||||||
license = "MIT"
|
license = "MIT"
|
||||||
name = "cursive"
|
name = "cursive"
|
||||||
readme = "Readme.md"
|
readme = "Readme.md"
|
||||||
repository = "https://github.com/gyscos/Cursive"
|
repository = "https://github.com/gyscos/cursive"
|
||||||
version = "0.12.1-alpha.0"
|
version = "0.12.1-alpha.0"
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
|
||||||
[badges.travis-ci]
|
[badges.travis-ci]
|
||||||
repository = "gyscos/Cursive"
|
repository = "gyscos/cursive"
|
||||||
|
|
||||||
[badges.appveyor]
|
[badges.appveyor]
|
||||||
repository = "gyscos/Cursive"
|
repository = "gyscos/cursive"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
enum-map = "0.5"
|
enum-map = "0.5"
|
||||||
|
22
Readme.md
22
Readme.md
@ -1,13 +1,13 @@
|
|||||||
# Cursive
|
# Cursive
|
||||||
|
|
||||||
[![crates.io](https://meritbadge.herokuapp.com/cursive)](https://crates.io/crates/cursive)
|
[![crates.io](https://meritbadge.herokuapp.com/cursive)](https://crates.io/crates/cursive)
|
||||||
[![Build Status (travis)](https://travis-ci.org/gyscos/Cursive.svg?branch=master)](https://travis-ci.org/gyscos/Cursive)
|
[![Build Status (travis)](https://travis-ci.org/gyscos/cursive.svg?branch=master)](https://travis-ci.org/gyscos/cursive)
|
||||||
[![Build status (appveyor)](https://ci.appveyor.com/api/projects/status/uk5pww718jsp5x2l/branch/master?svg=true)](https://ci.appveyor.com/project/gyscos/cursive/branch/master)
|
[![Build status (appveyor)](https://ci.appveyor.com/api/projects/status/uk5pww718jsp5x2l/branch/master?svg=true)](https://ci.appveyor.com/project/gyscos/cursive/branch/master)
|
||||||
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
|
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
|
||||||
[![Gitter chat](https://badges.gitter.im/gyscos/cursive.png)](https://gitter.im/cursive-rs/cursive)
|
[![Gitter chat](https://badges.gitter.im/gyscos/cursive.png)](https://gitter.im/cursive-rs/cursive)
|
||||||
|
|
||||||
|
|
||||||
Cursive is a TUI (Text User Interface) library for rust. It uses ncurses by default, but [other backends are available](https://github.com/gyscos/Cursive/wiki/Backends).
|
Cursive is a TUI (Text User Interface) library for rust. It uses ncurses by default, but [other backends are available](https://github.com/gyscos/cursive/wiki/Backends).
|
||||||
|
|
||||||
It allows you to build rich user interfaces for terminal applications.
|
It allows you to build rich user interfaces for terminal applications.
|
||||||
|
|
||||||
@ -24,10 +24,10 @@ Or to use the latest git version:
|
|||||||
|
|
||||||
```toml
|
```toml
|
||||||
[dependencies]
|
[dependencies]
|
||||||
cursive = { git = "https://github.com/gyscos/Cursive" }
|
cursive = { git = "https://github.com/gyscos/cursive" }
|
||||||
```
|
```
|
||||||
|
|
||||||
([You will also need ncurses installed.](https://github.com/gyscos/Cursive/wiki/Install-ncurses))
|
([You will also need ncurses installed.](https://github.com/gyscos/cursive/wiki/Install-ncurses))
|
||||||
|
|
||||||
```rust,no_run
|
```rust,no_run
|
||||||
use cursive::Cursive;
|
use cursive::Cursive;
|
||||||
@ -47,9 +47,9 @@ fn main() {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
[![Cursive dialog example](https://raw.githubusercontent.com/gyscos/Cursive/master/doc/cursive_example.png)](examples/dialog.rs)
|
[![Cursive dialog example](https://raw.githubusercontent.com/gyscos/cursive/master/doc/cursive_example.png)](examples/dialog.rs)
|
||||||
|
|
||||||
Check out the other [examples](https://github.com/gyscos/Cursive/tree/master/examples) to get these results, and more:
|
Check out the other [examples](https://github.com/gyscos/cursive/tree/master/examples) to get these results, and more:
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<a href="examples/edit.rs"><img src="https://imgur.com/CQgSwly.png" alt="edit.rs example", width="48%" /></a>
|
<a href="examples/edit.rs"><img src="https://imgur.com/CQgSwly.png" alt="edit.rs example", width="48%" /></a>
|
||||||
@ -66,9 +66,9 @@ _(Colors may depend on your terminal configuration.)_
|
|||||||
|
|
||||||
These tutorials may help you get started with cursive:
|
These tutorials may help you get started with cursive:
|
||||||
|
|
||||||
* [Starting with cursive: (1/3)](https://github.com/gyscos/Cursive/tree/master/doc/tutorial_1.md)
|
* [Starting with cursive: (1/3)](https://github.com/gyscos/cursive/tree/master/doc/tutorial_1.md)
|
||||||
* [Starting with cursive: (2/3)](https://github.com/gyscos/Cursive/tree/master/doc/tutorial_2.md)
|
* [Starting with cursive: (2/3)](https://github.com/gyscos/cursive/tree/master/doc/tutorial_2.md)
|
||||||
* [Starting with cursive: (3/3)](https://github.com/gyscos/Cursive/tree/master/doc/tutorial_3.md)
|
* [Starting with cursive: (3/3)](https://github.com/gyscos/cursive/tree/master/doc/tutorial_3.md)
|
||||||
|
|
||||||
## Third-party views
|
## Third-party views
|
||||||
|
|
||||||
@ -96,7 +96,7 @@ First off, terminals are messy. A small set of features is standard, but beyond
|
|||||||
|
|
||||||
* **Colors**: the basic 8-colors palette should be broadly supported. User-defined colors is not supported in the raw linux TTY, but should work in most terminals, although it's still kinda experimental.
|
* **Colors**: the basic 8-colors palette should be broadly supported. User-defined colors is not supported in the raw linux TTY, but should work in most terminals, although it's still kinda experimental.
|
||||||
* **UTF-8**: Currently Cursive really expects a UTF-8 locale. It may eventually get patched to support window borders on other locales, but it's not a priority.
|
* **UTF-8**: Currently Cursive really expects a UTF-8 locale. It may eventually get patched to support window borders on other locales, but it's not a priority.
|
||||||
There is initial support for [wide characters](https://en.wikipedia.org/wiki/CJK_characters). [RTL](https://en.wikipedia.org/wiki/Right-to-left) support [is planned](https://github.com/gyscos/Cursive/issues/31), but still very early.
|
There is initial support for [wide characters](https://en.wikipedia.org/wiki/CJK_characters). [RTL](https://en.wikipedia.org/wiki/Right-to-left) support [is planned](https://github.com/gyscos/cursive/issues/31), but still very early.
|
||||||
|
|
||||||
### Input
|
### Input
|
||||||
|
|
||||||
@ -108,4 +108,4 @@ There is initial support for [wide characters](https://en.wikipedia.org/wiki/CJK
|
|||||||
|
|
||||||
## Alternatives
|
## Alternatives
|
||||||
|
|
||||||
See also [tui-rs](https://github.com/fdehau/tui-rs) - and a small [comparison page](https://github.com/gyscos/Cursive/wiki/Cursive-vs-tui%E2%80%90rs).
|
See also [tui-rs](https://github.com/fdehau/tui-rs) - and a small [comparison page](https://github.com/gyscos/cursive/wiki/Cursive-vs-tui%E2%80%90rs).
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
//! [Cursive] is a [TUI] library - it lets you easily build rich interfaces
|
//! [Cursive] is a [TUI] library - it lets you easily build rich interfaces
|
||||||
//! for use in a terminal.
|
//! for use in a terminal.
|
||||||
//!
|
//!
|
||||||
//! [Cursive]: https://github.com/gyscos/Cursive
|
//! [Cursive]: https://github.com/gyscos/cursive
|
||||||
//! [TUI]: https://en.wikipedia.org/wiki/Text-based_user_interface
|
//! [TUI]: https://en.wikipedia.org/wiki/Text-based_user_interface
|
||||||
//!
|
//!
|
||||||
//! ## Getting started
|
//! ## Getting started
|
||||||
|
@ -28,7 +28,7 @@ pub type OnSubmit = dyn Fn(&mut Cursive, &str);
|
|||||||
///
|
///
|
||||||
/// From the [edit example][1].
|
/// From the [edit example][1].
|
||||||
///
|
///
|
||||||
/// [1]: https://github.com/gyscos/Cursive/blob/master/examples/edit.rs
|
/// [1]: https://github.com/gyscos/cursive/blob/master/examples/edit.rs
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # use cursive::Cursive;
|
/// # use cursive::Cursive;
|
||||||
|
Loading…
Reference in New Issue
Block a user