Skip to content

Commit 5178d2c

Browse files
committed
Add README and LICENSE
1 parent 181ea33 commit 5178d2c

File tree

4 files changed

+64
-1
lines changed

4 files changed

+64
-1
lines changed

.github/workflows/release.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ jobs:
4646
with:
4747
tag_name: ${{ github.ref }}
4848
release_name: Release ${{ github.ref }}
49-
draft: true
49+
draft: false
5050
prerelease: false
51+
body: |
52+
See [the official changelog](https://changelog.cursor.sh/).
5153
5254
- name: Upload Release Assets
5355
uses: softprops/action-gh-release@v1

LICENSE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License
2+
3+
Copyright (c) 2024 Coder Technologies Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<h1>
2+
<img src="./logo.png" width="64px" align="center">
3+
Cursor for ARM
4+
</h1>
5+
6+
[Cursor](https://cursor.com) built for Linux and Windows ARM.
7+
8+
The official issue tracker has numerous issues ([#1532](https://github.com/getcursor/cursor/issues/1532) and [#1410](https://github.com/getcursor/cursor/issues/1410)) for official ARM support. Read the [FAQ](#faq) to learn how this works.
9+
10+
> [!NOTE]
11+
> These are unofficial builds.
12+
13+
## Install
14+
15+
Download the [latest release](https://github.com/coder/cursor-arm/releases/latest) and execute it.
16+
17+
For Nix users, simply `nix build` and run.
18+
19+
## FAQ
20+
21+
### How is this possible?
22+
23+
Cursor is a closed-source fork of VS Code based on Electron that distributes using `AppImage`.
24+
25+
An `AppImage` is an executable archive that can be extracted with `7z`. The contents are virtually the same as the built and distributed archives of VS Code.
26+
27+
Overwriting the JavaScript for VS Code with Cursor's archive creates a Cursor build.
28+
29+
```bash
30+
cp -R $cursorSrc/resources/app/out $vscodeSrc/resources/app/
31+
```
32+
33+
See the [build process](./flake.nix#L48) to see exactly how this works.
34+
35+
### Shouldn't Cursor do this?
36+
37+
Yes. Hopefully they will!
38+
39+
### Is this stable?
40+
41+
Seemingly. The [build process](./flake.nix#L48) is quite simple. Try it for yourself!

logo.png

47.5 KB
Loading

0 commit comments

Comments
 (0)