Skip to content

Commit

Permalink
Update FUNDING.yml with additional sponsors and create README.md for …
Browse files Browse the repository at this point in the history
…project overview
  • Loading branch information
oligamiq committed Nov 25, 2024
1 parent 6ae3f78 commit 18cbe91
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 5 deletions.
6 changes: 3 additions & 3 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g.,
[oligamiq]
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g.,
[oligamiq, bjorn3, whitequark]
# patreon: # Replace with a single Patreon username
# open_collective: # Replace with a single Open Collective username
# ko_fi: # Replace with a single Ko-fi username
Expand All @@ -13,5 +13,5 @@ github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g.,
# polar: # Replace with a single Polar username
# buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
# thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g.,
custom: # Replace with up to 4 custom sponsorship URLs e.g.,
[https://www.amazon.co.jp/hz/wishlist/ls/3KDVR70NQ0DRQ?ref_=list_d_wl_lfu_nav_2]
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Rubrc
Rubrc is a rustc that runs in the browser.

It is a port of the rustc compiler to WebAssembly. It is a work in progress and is not yet ready for general use.

This have some bottlenecks, like the lack of thread spawn is very slow.

# Special Thanks
## Projects
- [rubri](https://github.com/LyonSyonII/rubri) by [LyonSyonII](https://github.com/LyonSyonII) - At first, I was using this project to run it on the browser.
- [browser_wasi_shim](https://github.com/bjorn3/browser_wasi_shim) by [bjorn3](https://github.com/bjorn3) - This project is used to run the WASI on the browser.
- [browser_wasi_shim-threads](https://github.com/bjorn3/browser_wasi_shim/tree/main/threads#README) by [oligamiq](https://github.com/oligamiq) - This project is used to run the WASI with threads on the browser.
- [rust_wasm](https://github.com/oligamiq/rust_wasm) by [oligamiq](https://github.com/oligamiq) - This is a project that hosts files and sysroots compiled from Rustc, supporting from Tier 1 to Tier 2 with host in this project, and compiled to wasm.

## People
- [bjorn3](https://github.com/bjorn3) - He created the foundation for compiling Rustc to WASI and managing linker relations.
- [oligamiq](https://github.com/oligamiq) - He created Rustc compiled with LLVM Backend to WASI.
- [whitequark](https://github.com/whitequark) - He created the LLVM to WASI.
- [rust-lang](https://github.com/rust-lang) - They created the Rust language.

# Issues
This has been created in a rather haphazard manner, but as the creator, I will be busy for a while, so it’s been left in this state for now. There are numerous bugs, such as commands throwing errors and subsequently becoming unusable, but feel free to open issues if necessary. Minor pull requests to improve usability are also welcome, so feel free to tweak it as you like.

# Features
! This project require coop coep headers to work, so you need to run it on a server or use a browser extension to allow it.
- [x] Run rustc on the browser

# Funding
The projects that this project depends on, namely [browser_wasi_shim-threads](https://www.npmjs.com/package/@oligami/browser_wasi_shim-threads), [rust_wasm](https://github.com/oligamiq/rust_wasm), and [shared-object](https://www.npmjs.com/package/@oligami/shared-object), are all my projects. The [toolchain-for-building-rustc](https://github.com/oligamiq/toolchain-for-building-rustc) that rust_wasm depends on is also my project. I was the one who enabled the LLVM backend for rustc, and ultimately, I aim to make rustc executable in browsers that support wasm and allow cargo to run seamlessly on the web.

If you like or want to use this series of projects, I would appreciate it if you could contribute financially via the sponsor button.

Please note that coding has temporarily stopped due to being busy, and there may be missing or incorrect documentation. Although it works, it is currently in a state with various issues, so I do not recommend using it for production.

# License
This project is licensed under the MIT OR Apache-2.0 License.
2 changes: 1 addition & 1 deletion page/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<title>Solid App</title>
<title>Rubrc</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
Expand Down
59 changes: 58 additions & 1 deletion page/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 18cbe91

Please sign in to comment.