This commit is contained in:
TimonPost 2018-07-14 23:02:02 +02:00
commit 10f3ccb07b
6 changed files with 63 additions and 4 deletions

3
.gitignore vendored
View File

@ -1,3 +1,4 @@
/target/ target/
.idea/
**/*.rs.bk **/*.rs.bk
Cargo.lock Cargo.lock

View File

@ -34,6 +34,7 @@
<favorites_list name="crossterm" /> <favorites_list name="crossterm" />
</component> </component>
<component name="FileEditorManager"> <component name="FileEditorManager">
<<<<<<< HEAD
<leaf> <leaf>
<file leaf-file-name="README.md" pinned="false" current-in-tab="true"> <file leaf-file-name="README.md" pinned="false" current-in-tab="true">
<entry file="file://$PROJECT_DIR$/README.md"> <entry file="file://$PROJECT_DIR$/README.md">
@ -43,6 +44,14 @@
<caret line="26" column="9" lean-forward="true" selection-start-line="26" selection-start-column="9" selection-end-line="26" selection-end-column="9" /> <caret line="26" column="9" lean-forward="true" selection-start-line="26" selection-start-column="9" selection-end-line="26" selection-end-column="9" />
</first_editor> </first_editor>
<second_editor /> <second_editor />
=======
<leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
<file leaf-file-name="Cargo.toml" pinned="false" current-in-tab="true">
<entry file="file://$PROJECT_DIR$/Cargo.toml">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="119">
<caret line="7" column="15" lean-forward="true" selection-start-line="7" selection-start-column="15" selection-end-line="7" selection-end-column="15" />
>>>>>>> master
</state> </state>
</provider> </provider>
</entry> </entry>
@ -441,7 +450,11 @@
<servers /> <servers />
</component> </component>
<component name="TimeTrackingManager"> <component name="TimeTrackingManager">
<<<<<<< HEAD
<option name="totallyTimeSpent" value="811135000" /> <option name="totallyTimeSpent" value="811135000" />
=======
<option name="totallyTimeSpent" value="353900000" />
>>>>>>> master
</component> </component>
<component name="ToolWindowManager"> <component name="ToolWindowManager">
<frame x="-8" y="-8" width="2576" height="1056" extended-state="6" /> <frame x="-8" y="-8" width="2576" height="1056" extended-state="6" />
@ -653,8 +666,13 @@
<entry file="file://$PROJECT_DIR$/test.md" /> <entry file="file://$PROJECT_DIR$/test.md" />
<entry file="file://$PROJECT_DIR$/docs/ReleaseNotesVersion 0.2.2.md"> <entry file="file://$PROJECT_DIR$/docs/ReleaseNotesVersion 0.2.2.md">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<<<<<<< HEAD
<state relative-caret-position="23"> <state relative-caret-position="23">
<caret line="1" column="70" selection-start-line="1" selection-start-column="70" selection-end-line="1" selection-end-column="70" /> <caret line="1" column="70" selection-start-line="1" selection-start-column="70" selection-end-line="1" selection-end-column="70" />
=======
<state relative-caret-position="238">
<caret line="14" column="49" selection-start-line="14" selection-start-column="49" selection-end-line="14" selection-end-column="49" />
>>>>>>> master
</state> </state>
</provider> </provider>
</entry> </entry>
@ -793,8 +811,13 @@
</entry> </entry>
<entry file="file://$PROJECT_DIR$/examples/Crossterm 0.2.3/program_examples/first_depth_search/src/main.rs"> <entry file="file://$PROJECT_DIR$/examples/Crossterm 0.2.3/program_examples/first_depth_search/src/main.rs">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<<<<<<< HEAD
<state relative-caret-position="74"> <state relative-caret-position="74">
<caret line="36" selection-start-line="36" selection-end-line="36" /> <caret line="36" selection-start-line="36" selection-end-line="36" />
=======
<state relative-caret-position="53">
<caret line="113" column="1" selection-start-line="113" selection-start-column="1" selection-end-line="113" selection-end-column="1" />
>>>>>>> master
</state> </state>
</provider> </provider>
</entry> </entry>
@ -805,6 +828,7 @@
</state> </state>
</provider> </provider>
</entry> </entry>
<<<<<<< HEAD
<entry file="file://$PROJECT_DIR$/README.md"> <entry file="file://$PROJECT_DIR$/README.md">
<provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]"> <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
<state split_layout="SPLIT"> <state split_layout="SPLIT">
@ -812,6 +836,12 @@
<caret line="26" column="9" lean-forward="true" selection-start-line="26" selection-start-column="9" selection-end-line="26" selection-end-column="9" /> <caret line="26" column="9" lean-forward="true" selection-start-line="26" selection-start-column="9" selection-end-line="26" selection-end-column="9" />
</first_editor> </first_editor>
<second_editor /> <second_editor />
=======
<entry file="file://$PROJECT_DIR$/Cargo.toml">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="119">
<caret line="7" column="15" lean-forward="true" selection-start-line="7" selection-start-column="15" selection-end-line="7" selection-end-column="15" />
>>>>>>> master
</state> </state>
</provider> </provider>
</entry> </entry>

View File

@ -1,6 +1,6 @@
[package] [package]
name = "crossterm" name = "crossterm"
version = "0.2.0" version = "0.2.2"
authors = ["T Post <timonpost@hotmail.nl>"] authors = ["T Post <timonpost@hotmail.nl>"]
description = "An crossplatform terminal library for manipulating terminals." description = "An crossplatform terminal library for manipulating terminals."
repository = "https://github.com/TimonPost/crossterm" repository = "https://github.com/TimonPost/crossterm"

View File

@ -34,6 +34,7 @@ Version `0.2.3` of Crossterm will have API braking changes. If you are reading t
This documentation is only for Crossterm version `0.2.3` if you have an older version of Crossterm I suggest you to check the [Upgrade Manual](link_to_manual) for more infomation about how to upgrade to an newer version or checkout the [README.md](link_to_backup_readme) from the previous versions. Also you could take a look at the [examples](link) from the previous versions of Crossterm. This documentation is only for Crossterm version `0.2.3` if you have an older version of Crossterm I suggest you to check the [Upgrade Manual](link_to_manual) for more infomation about how to upgrade to an newer version or checkout the [README.md](link_to_backup_readme) from the previous versions. Also you could take a look at the [examples](link) from the previous versions of Crossterm.
Add the Crossterm package to your `Cargo.toml` file. Add the Crossterm package to your `Cargo.toml` file.
``` ```
@ -63,6 +64,7 @@ version [0.2.0](https://docs.rs/crossterm/0.2.0/crossterm/),
version [0.2.1](https://docs.rs/crossterm/0.2.1/crossterm/) version [0.2.1](https://docs.rs/crossterm/0.2.1/crossterm/)
and [0.2.3](link) and [0.2.3](link)
<<<<<<< HEAD
- Code functionalities Examples: - Code functionalities Examples:
version [0.1.0](link_examples_01), version [0.1.0](link_examples_01),
version [0.2.0](link_examples_02), version [0.2.0](link_examples_02),
@ -280,6 +282,7 @@ Crossterm is using ANSI escape codes by default for both unix and windows system
But for Windows it is a bit more complicater since Windows versions 8 or lower are not supporting ANSI escape codes. This is why we use WinApi for those machines. For Windows 10 ANSI codes will be the default. But for Windows it is a bit more complicater since Windows versions 8 or lower are not supporting ANSI escape codes. This is why we use WinApi for those machines. For Windows 10 ANSI codes will be the default.
## Notice ## Notice
<<<<<<< HEAD
This libary is not stable yet but I expect it ot not to change that mutch anymore. This libary is not stable yet but I expect it ot not to change that mutch anymore.
And if there are any changes that affect previous versions I will [describe](link_to_upgrade_manual) what to change when upgrading Crossterm to an newer version. And if there are any changes that affect previous versions I will [describe](link_to_upgrade_manual) what to change when upgrading Crossterm to an newer version.

24
UPGRADE Manual Normal file
View File

@ -0,0 +1,24 @@
Upgrade crossterm 0.2 to 0.2.1
Namespaces:
I have changed the namespaces. I found the namsespaces to long so I have shortened them like the following:
Old: crossterm::crossterm_style
New: crossterm::style
Old: crossterm::crossterm_terminal
New: crossterm::terminal
Old: crossterm::crossterm_cursor
New: crossterm::cursor
Method names that changed [Issue 4](https://github.com/TimonPost/crossterm/issues/4):
Old: crossterm::crossterm_cursor::get();
New: use crossterm::cursor::cursor();
Old: crossterm::crossterm_terminal::get();
New: use crossterm::terminal::terminal();
Old: crossterm::crossterm_style::color::get();
New: use crossterm::style::color::color();

View File

@ -1,7 +1,7 @@
//! Crossterm provides the same core functionalities for both windows and unix systems. //! Crossterm provides the same core functionalities for both windows and unix systems.
//! Crossterm aims to be simple and easy to call in code. //! Crossterm aims to be simple and easy to call in code.
//! True the simplicity of Crossterm you do not have to worry about the platform your working with. //! True the simplicity of Crossterm you do not have to worry about the platform your working with.
//! You can just call the action you want to preform and under water it will check what to do based on the current platform. //! You can just call the action you want to perform and under water it will check what to do based on the current platform.
#[macro_use] #[macro_use]
mod shared; mod shared;
@ -27,5 +27,6 @@ use state::state_manager::StateManager;
extern crate libc; extern crate libc;
#[cfg(unix)] #[cfg(unix)]
extern crate termios; extern crate termios;
#[cfg(windows)] #[cfg(windows)]
extern crate winapi; extern crate winapi;