Skip to content

Commit

Permalink
Changes before publishing to crates.io
Browse files Browse the repository at this point in the history
  • Loading branch information
joaofl committed Jan 9, 2024
1 parent 4be6e3d commit 7a3359c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 29 deletions.
25 changes: 0 additions & 25 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,35 +37,10 @@ jobs:
profile: minimal
toolchain: stable

- name: Install build dependencies
run: |
sudo apt install libgtk-3-dev libatk1.0-dev
rustup target add $TARGETS
- name: Build for Linux x86_64
continue-on-error: false
run: cargo build --release

- name: Test for Linux x86_64
continue-on-error: true
run: cargo test --release

# ###################################
# - name: Set up Rust for ARM
# uses: actions-rs/toolchain@v1
# with:
# profile: minimal
# toolchain: stable-armv7-unknown-linux-gnueabihf

# - name: Build for ARM
# run: cargo build --release --target=armv7-unknown-linux-gnueabihf

# ###################################
# - name: Set up Rust for Windows
# uses: actions-rs/toolchain@v1
# with:
# profile: minimal
# toolchain: stable-x86_64-pc-windows-msvc

# - name: Build for Windows
# run: cargo build --release --target=x86_64-pc-windows-msvc
6 changes: 6 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ authors = ["João Loureiro"]
name = "quick-serve"
version = "0.1.0"
edition = "2021"
license = "MIT"
repository = "https://github.com/joaofl/quick-serve"
homepage = "https://github.com/joaofl/quick-serve"
description = "Quick-serve: A zero-config, multi-platform, multi-protocol standalone server for a prompt file serving."
categories = ["networking", "command-line-utilities", "development-tools"]


[dependencies]
# TODO: Put only the used features
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![Build Status](https://github.com/joaofl/quick-serve/actions/workflows/rust.yml/badge.svg)](https://github.com/joaofl/quick-serve/actions/workflows/rust.yml)
[![crates.io](https://img.shields.io/crates/v/quick-serve.svg)](https://crates.io/crates/quick-serve)
![](https://tokei.rs/b1/github/joaofl/quick-serve?category=code)
[![](https://deps.rs/repo/github/joaofl/quick-serve/status.svg)](https://deps.rs/repo/github/joaofl/quick-serve)

Expand All @@ -15,7 +16,7 @@ devices in the course of various development tasks. Whether the objective is upg
Kernel from the bootloader, retrieving packages from remote repositories, fetching a Git repository or sharing files with
your colleague next desk, the constant requirement is a quick and straightforward file server. The capability to promptly
set up an FTP, TFTP, or HTTP server proves to be a time-saving and efficient solution in navigating the most diverse
embedded systems development scenarios.
file exchange scenarios.

I developed this application as an exercise in learning Rust because I couldn't find a solution that seamlessly served
multiple protocols, was headless, and supported various platforms. Unlike many dedicated servers tailored for either
Expand Down Expand Up @@ -51,10 +52,9 @@ Options:

-V, --version
Print version

```

## Wishlist
## Features and To-do List

- [x] FTP
- [x] HTTP
Expand All @@ -63,10 +63,12 @@ Options:
- [ ] SFTP
- [x] Headless version
- [ ] User interface
- [ ] Timout
- [ ] Serve N files and exit
- [ ] Timeout
- [ ] Show transfer rate
- [ ] Color-code logs according to protocol
- [ ] Add logs filter levels and source
- [ ] Refine on each protocol's specific logs

## Compiling on Ubuntu 22.04

Expand Down

0 comments on commit 7a3359c

Please sign in to comment.