Skip to content

nyanrus/noraneko

Repository files navigation

Welcome to Noraneko Browser Repository

Warning

Experimental!

Noraneko Browser is currently testbed for Floorp 12.

Have a nice day!

Contributing

Thank you for investing your time.
Please check CONTRIBUTING.md

Noraneko Docs available!

Please visit noraneko.pages.dev!

How to Start Development

  1. Run pnpm install

You can run pnpm build and pnpm dev. pnpm build outputs files, while pnpm dev is used for debugging the code with file watch. Refer to "How to Debug" for instructions on using pnpm dev.

How to debug

Windows

  1. Install zstd and add it to the PATH.
  2. Visit noraneko-runtime Action. the Release version is recommended.
  3. Download artifact named as "noraneko-win-amd64-dev" and place in project root.
  4. Run pnpm dev.
  5. The browser will launch, and if you change some files, you could rerun pnpm dev. If the source you changed supports HMR, it will reload the browser so you'll not need to rerun.

Credits

Thank you @CutterKnife for the logo!

Projects that are inspired by or used in Noraneko

Thank you!

Useful Links

Link to Noraneko Runtime Repository

LICENSE

Mozilla Public License 2.0