mirror of
https://github.com/gitbutlerapp/gitbutler.git
synced 2024-07-07 08:56:31 +03:00
fix: rename eslint/prettier configs to mjs in root
This commit is contained in:
ndom91
parent
e84946d9b5
commit
628fdd1459
|
|
@ -9,6 +9,7 @@ package
|
|||
.env.*
|
||||
!.env.example
|
||||
crates/
|
||||
flake*
|
||||
|
||||
# Ignore files for PNPM, NPM and YARN
|
||||
pnpm-lock.yaml
|
||||
|
|
|
|||
|
|
@ -9,29 +9,28 @@ you right. Let's get started.
|
|||
|
||||
- [Overview](#overview)
|
||||
- [The Basics](#the-basics)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Install dependencies](#install-dependencies)
|
||||
- [Run the app](#run-the-app)
|
||||
- [Lint & format](#lint--format)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Install dependencies](#install-dependencies)
|
||||
- [Run the app](#run-the-app)
|
||||
- [Lint & format](#lint--format)
|
||||
- [Debugging](#debugging)
|
||||
- [Logs](#logs)
|
||||
- [Tokio](#tokio)
|
||||
- [Logs](#logs)
|
||||
- [Tokio](#tokio)
|
||||
- [Building](#building)
|
||||
- [Building on Windows](#building-on-windows)
|
||||
- [File permissions](#file-permissions)
|
||||
- [Perl](#perl)
|
||||
- [Crosscompilation](#crosscompilation)
|
||||
- [Building on Windows](#building-on-windows)
|
||||
- [File permissions](#file-permissions)
|
||||
- [Perl](#perl)
|
||||
- [Crosscompilation](#crosscompilation)
|
||||
- [Design](#design)
|
||||
- [Contributing](#contributing)
|
||||
- [Some Other Random Notes](#some-other-random-notes)
|
||||
- [Icon generation](#icon-generation)
|
||||
- [Release](#release)
|
||||
- [Versioning](#versioning)
|
||||
- [Publishing](#publishing)
|
||||
- [Icon generation](#icon-generation)
|
||||
- [Release](#release)
|
||||
- [Versioning](#versioning)
|
||||
- [Publishing](#publishing)
|
||||
- [Development mode OAuth login](#development-mode-oauth-login)
|
||||
- [Joining the GitButler Team](#joining-the-gitbutler-team)
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
|
@ -134,18 +133,18 @@ The app writes logs into:
|
|||
|
||||
We are also collecting tokio's runtime tracing information that could be viewed using [tokio-console](https://github.com/tokio-rs/console#tokio-console-prototypes):
|
||||
|
||||
- development:
|
||||
```bash
|
||||
$ tokio-console
|
||||
```
|
||||
- nightly:
|
||||
```bash
|
||||
$ tokio-console http://127.0.0.1:6668
|
||||
```
|
||||
- production:
|
||||
```bash
|
||||
$ tokio-console http://127.0.0.1:6667
|
||||
```
|
||||
- development:
|
||||
```bash
|
||||
$ tokio-console
|
||||
```
|
||||
- nightly:
|
||||
```bash
|
||||
$ tokio-console http://127.0.0.1:6668
|
||||
```
|
||||
- production:
|
||||
```bash
|
||||
$ tokio-console http://127.0.0.1:6667
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -175,7 +174,7 @@ Sometimes npm's prefix is incorrect on Windows, we can check this via:
|
|||
npm config get prefix
|
||||
```
|
||||
|
||||
If it's not `C:\Users\<username>\AppData\Roaming\npm` or another folder that is
|
||||
If it's not `C:\Users\<username>\AppData\Roaming\npm` or another folder that is
|
||||
normally writable, then we can set it in Powershell:
|
||||
|
||||
```sh
|
||||
|
|
@ -205,10 +204,10 @@ which only allow ARM Windows to be used.
|
|||
|
||||
The `winapi` dependency on `gitbutler-git` doesn't currently compile on ARM,
|
||||
which means cross-compilation to x86-64 is required to workaround that. Besides,
|
||||
most users will probably still be on INTEL machines, making this capability
|
||||
most users will probably still be on INTEL machines, making this capability
|
||||
a common requirement.
|
||||
|
||||
In a Git `bash`, *with MSVC for x86-64 installed on the system*, run the following
|
||||
In a Git `bash`, _with MSVC for x86-64 installed on the system_, run the following
|
||||
to prepare the environment.
|
||||
|
||||
```bash
|
||||
|
|
@ -302,4 +301,3 @@ If you are interested in joining our small but tightly knit engineering team, we
|
|||
- [Senior Rust developer](https://gitbutler.homerun.co/senior-rust-developer) (Onsite Berlin)
|
||||
- [Senior TypeScript developer](https://gitbutler.homerun.co/senior-typescript-developer) (Onsite Berlin)
|
||||
- [Senior Rails developer](https://gitbutler.homerun.co/senior-rails-developer) (Onsite Berlin)
|
||||
|
||||
|
|
|
|||
11
README.md
11
README.md
|
|
@ -37,10 +37,8 @@
|
|||
[s5]: https://img.shields.io/youtube/channel/subscribers/UCEwkZIHGqsTGYvX8wgD0LoQ
|
||||
[l5]: https://www.youtube.com/@gitbutlerapp
|
||||
[s6]: https://img.shields.io/badge/GitButler-%23B9F4F2?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMzkiIGhlaWdodD0iMjgiIHZpZXdCb3g9IjAgMCAzOSAyOCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTI1LjIxNDUgMTIuMTk5N0wyLjg3MTA3IDEuMzg5MTJDMS41NDI5NSAwLjc0NjUzMiAwIDEuNzE0MDYgMCAzLjE4OTQ3VjI0LjgxMDVDMCAyNi4yODU5IDEuNTQyOTUgMjcuMjUzNSAyLjg3MTA3IDI2LjYxMDlMMjUuMjE0NSAxNS44MDAzQzI2LjcxOTcgMTUuMDcyMSAyNi43MTk3IDEyLjkyNzkgMjUuMjE0NSAxMi4xOTk3WiIgZmlsbD0iYmxhY2siLz4KPHBhdGggZD0iTTEzLjc4NTUgMTIuMTk5N0wzNi4xMjg5IDEuMzg5MTJDMzcuNDU3MSAwLjc0NjUzMiAzOSAxLjcxNDA2IDM5IDMuMTg5NDdWMjQuODEwNUMzOSAyNi4yODU5IDM3LjQ1NzEgMjcuMjUzNSAzNi4xMjg5IDI2LjYxMDlMMTMuNzg1NSAxNS44MDAzQzEyLjI4MDMgMTUuMDcyMSAxMi4yODAzIDEyLjkyNzkgMTMuNzg1NSAxMi4xOTk3WiIgZmlsbD0idXJsKCNwYWludDBfcmFkaWFsXzMxMF8xMjkpIi8%2BCjxkZWZzPgo8cmFkaWFsR3JhZGllbnQgaWQ9InBhaW50MF9yYWRpYWxfMzEwXzEyOSIgY3g9IjAiIGN5PSIwIiByPSIxIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgZ3JhZGllbnRUcmFuc2Zvcm09InRyYW5zbGF0ZSgxNi41NzAxIDE0KSBzY2FsZSgxOS44NjQxIDE5LjgzODMpIj4KPHN0b3Agb2Zmc2V0PSIwLjMwMTA1NiIgc3RvcC1vcGFjaXR5PSIwIi8%2BCjxzdG9wIG9mZnNldD0iMSIvPgo8L3JhZGlhbEdyYWRpZW50Pgo8L2RlZnM%2BCjwvc3ZnPgo%3D
|
||||
|
||||
[l6]: https://gitbutler.com/
|
||||
|
||||
|
||||
GitButler is a git client that lets you work on multiple branches at the same time.
|
||||
It allows you to quickly organize file changes into separate branches while still having them applied to your working directory.
|
||||
You can then push branches individually to your remote, or directly create pull requests.
|
||||
|
|
@ -94,14 +92,14 @@ GitButler is a [Tauri](https://tauri.app/)-based application. Its UI is written
|
|||
|
||||
Using Git you can stash your changes and switch to another branch, where you can commit, and push your fix.
|
||||
|
||||
*With GitButler* you simply assign your fix to a separate virtual branch, which you can individually push (or directly create a PR). An additional benefit is that you can retain the fix in your working directory while waiting for CI and/or code review.
|
||||
_With GitButler_ you simply assign your fix to a separate virtual branch, which you can individually push (or directly create a PR). An additional benefit is that you can retain the fix in your working directory while waiting for CI and/or code review.
|
||||
|
||||
### Trying Someone Else's Branch Together With My Work in Progress
|
||||
|
||||
> Say you want to test a branch from someone else for the purpose of code review.
|
||||
|
||||
Using Git trying out someone else's branch is a full context switch away from your own work.
|
||||
*With GitButler* you can apply and unapply (add / remove) any remote branch directly into your working directory.
|
||||
_With GitButler_ you can apply and unapply (add / remove) any remote branch directly into your working directory.
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
@ -129,8 +127,9 @@ If you want to skip right to getting the code to actually compile, take a look
|
|||
at the [DEVELOPMENT.md](DEVELOPMENT.md) file.
|
||||
|
||||
Want to show your support? Add a GitButler badge to your project's README:
|
||||
|
||||
```md
|
||||
[](https://gitbutler.com/)
|
||||
[](https://gitbutler.com/)
|
||||
```
|
||||
|
||||
[![BADGE][s6]][l6]
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user