Skip to content
This repository has been archived by the owner on Oct 8, 2024. It is now read-only.

Commit

Permalink
Merge pull request #82 from PThorpe92/dev
Browse files Browse the repository at this point in the history
docs for publishing on crates.io
  • Loading branch information
PThorpe92 authored Oct 30, 2023
2 parents 46ee1b0 + 5dc1099 commit 71ae4a2
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 5 deletions.
8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[package]
name = "CuTE-tui" # crates.io/crates/CuTE is taken :(
version = "0.1.0"
name = "CuTE-tui" # crates.io/crates/CuTE is taken :(
version = "0.0.9"
authors = ["PThorpe92 <[email protected]>"]
description = "A (ratatui) TUI for HTTP requests with libcurl, recursive downloads with wget, command storage and API key management"
license = "GPL-3.0"
edition = "2021"

Expand All @@ -10,15 +11,14 @@ name = "cute"
path = "src/main.rs"

[dependencies]
cross = "*"
crossterm = "0.27.0"
tui = { package = "ratatui", features = [
"crossterm",
"all-widgets",
"serde",
"macros",
], version = "0.23.0" }
tui-input = "*"
tui-input = "0.8.0"
tui-widget-list = "0.3.0"
lazy_static = "1.4.0"
rusqlite = { version = "0.29.0", features = ["bundled"] }
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ This tool is for when you don't need something as complex as Postman, but you al

## Installation

#### Prebuilt binaries for Windows and x86_64 Linux are available on the [Releases](https://github.com/PThorpe92/CuTE/tags) page.

### Install with Cargo:

- **Prerequisites**: Make sure you have Rust and Cargo installed on your system.

1. `cargo install cute_tui`

2. make sure that your `~/.cargo/bin` directory is in your PATH

3. `cute` or `cute --dump-config .` # this will put a config.toml file in your cwd. You can edit this and place it
in a dir `CuTE` in your `~/.config/` path (see below) to customize the colors of the application.


### Build from source:
1. **Prerequisites**: Make sure you have Rust and Cargo installed on your system.

2. **Clone the Repository**: Clone this repository to your local machine using the following command:
Expand All @@ -59,6 +74,7 @@ This tool is for when you don't need something as complex as Postman, but you al
##### cute [OPTIONAL] '--dump-config <PATH>' or '--db-path <'/PATH/to/cute.db'>'

- **--dump-config**: Dumps the default config.toml file to the specified path. If no path is specified, it will output it to the current working directory.
- This `config.toml` file needs to be placed in `~/.config/CuTE/{config.toml}` in order for the application to read it.
- currently the config file can only specify basic colors of the application, and the path to the sqlite database. More options will be added in the future.

- **--db-path**: Specify the path to the sqlite database. If no path is specified, it will default to `data_local_dir` working directory.(~/.local/share/CuTE/CuTE.db or the windows/macos equivalent)
Expand Down
1 change: 0 additions & 1 deletion src/screens/home.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
use super::render::handle_screen_defaults;
use crate::app::App;
use crate::request::command::Cmd;
use crate::request::curl::Curl;
use crate::request::wget::Wget;
use crate::screens::screen::Screen;
use tui::backend::Backend;
Expand Down

0 comments on commit 71ae4a2

Please sign in to comment.