Skip to content

Commit

Permalink
chroe: minor cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
DonIsaac committed Sep 19, 2024
1 parent 4d02f80 commit eeae5ef
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Thanks for contributing to Oxbuild!

The best ways to get involved are:

1. Look through [good first issues](https://github.com/DonIsaac/oxbuild/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) and pick something that looks interesting
2. Get involved with [oxc](https://github.com/oxc-project/oxc), which powers Oxbuild.

Expand All @@ -16,19 +17,20 @@ After you've cloned this repository, here's what you need to get set up:
# Click the link above for more ways to install this
cargo install cargo-binstall
```
2. Install [`just`](https://github.com/casey/just?tab=readme-ov-file#installation), a `make`-like task runner.
3. Install [`just`](https://github.com/casey/just?tab=readme-ov-file#installation), a `make`-like task runner.
```sh
# Click the link above for more ways to install just
cargo binstall just
```
3. Install other binaries for linting/checking:
4. Install other binaries for linting/checking:
```sh
just init
```

Look through `Justfile` to see all available scripts, or just run `just` (with no arguments) to see a help message of all commands available.

## Running

You can use `cargo oxbuild` as a `cargo run` shorthand. I personally find it easier than typing multiple CLI args each time :)

## Testing/Linting
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ cargo-dist-version = "0.22.1"
# CI backends to support
ci = "github"
# The installers to generate for each app
installers = ["shell", "powershell", "npm"]
installers = ["shell", "powershell", "npm"]
publish-jobs = ["npm"]
# Target platforms to build apps for (Rust target-triple syntax)
targets = [
Expand Down
2 changes: 1 addition & 1 deletion Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ build:
test:
cargo test


# Apply formatting fixes
fmt:
@cargo fmt --all
Expand All @@ -33,6 +32,7 @@ lint:
fix:
cargo clippy --no-deps --all-targets --all-features --fix --allow-staged
just fmt
typos -w
git status

# Make a release. `semver_kind` is major/minor/patch
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
[![NPM Version](https://img.shields.io/npm/v/oxbuild)](https://npmjs.com/package/oxbuild)
[![License](https://img.shields.io/crates/l/oxbuild)](./LICENSE)


An ultra-fast `tsc`-like compiler built on top of [oxc](https://github.com/oxc-project/oxc).

> #### 🚧 Under Construction
>
> Both Oxbuild and oxc are actively under construction and are not yet suitable for production use. If you find a bug in either project, we would love for you to open an issue on GitHub!
## Features
Expand Down

0 comments on commit eeae5ef

Please sign in to comment.