Skip to content

Commit e83ce70

Browse files
authored
Added documentation for contributing (#21)
* Added documentation for contributing * Fixed voilà typo * Undo readme formatting
1 parent 6482a41 commit e83ce70

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to contribute
2+
3+
We don't have guidelines for contributing just yet, so it's going to be a bit of a wild ride at first.
4+
But don't worry, we'll figure it out together. For now, just fork the repo, make your changes, and submit a pull request.
5+
We'll work together to make Backslash the best it can be. And if you have any questions or just want to chat about Backslash,
6+
feel free to join the [Backslash Discord server](https://discord.gg/sTzwBzDkK9). We can't wait to see what you do!
7+
8+
## Running the project locally
9+
10+
Running the project locally is a great way to see how the project works but also vital if you want to contribute to the project.
11+
Luckily, it's as easy as eating pie. Just follow the instructions below.
12+
13+
### Pre-requisites
14+
15+
You will be needing the following tools to run the project locally:
16+
17+
- [Node](https://nodejs.org/en/download)
18+
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install)
19+
20+
### Instructions
21+
22+
1. Create a fork of the project
23+
2. Clone the forked project to your local machine
24+
3. Run `yarn install` to install the dependencies
25+
4. Run `yarn start` to run the project
26+
27+
And voilà! You have the project running locally like a boss.
28+
Now you can make your changes and submit a pull request, good luck!.

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**The Raycast Clone Your Linux Desktop Deserves**
66

7-
> **"The failed uncle of the family"**
7+
> **"The failed uncle of the family"**
88
> _Because every family has that one uncle... you know, the one who's a bit of a screw-up but still kind of lovable in his own tragic way. That's Backslash, and Raycast is the golden child. But deep down, we all have a soft spot for the underdog. Right?_
99
1010
<p align="center"><img src="https://github.com/user-attachments/assets/408460b0-08f1-48ef-abbf-ad3a4004ffe2" width="30%"/> <img src="https://github.com/user-attachments/assets/3e5ecc6f-f108-4590-b64d-57be598417ad" width="30%"/> <img src="https://github.com/user-attachments/assets/67c812d9-4355-4de9-8c70-943676e0fc16" width="30%"/></p>
@@ -65,7 +65,7 @@ Then, simply point Backslash to your new plugins folder. Voila! You've just tran
6565

6666
### **Q: Will Backslash be available for macOS or Windows?**
6767

68-
**A:** Hahaha… You're funny. No, it won't. And here’s why: **Linux users deserve nice things too, and we’re tired of sharing.** You see, there are far too many gorgeous, well-polished apps that come out for macOS first, sometimes _maybe_ Windows, but they never give us a second thought. Well, Backslash is here for **us**, and we're keeping it that way.
68+
**A:** Hahaha… You're funny. No, it won't. And here’s why: **Linux users deserve nice things too, and we’re tired of sharing.** You see, there are far too many gorgeous, well-polished apps that come out for macOS first, sometimes _maybe_ Windows, but they never give us a second thought. Well, Backslash is here for **us**, and we're keeping it that way.
6969
So if you want your pretty little `.App` file, feel free to check out Raycast, and leave us to our grumbling and bash scripting. No hard feelings. _Kiss, kiss._
7070

7171
### **Q: Is Backslash stable?**
@@ -84,7 +84,8 @@ As for Mac users... Look, we don’t hate you either. It’s just that we, Linux
8484

8585
## Contributing
8686

87-
Contributions are more than welcome! We don't have guidelines for contributing just yet, so it's going to be a bit of a wild ride at first. But don't worry, we'll figure it out together. For now, just fork the repo, make your changes, and submit a pull request. We'll work together to make Backslash the best it can be. And if you have any questions or just want to chat about Backslash, feel free to join the [Backslash Discord server](https://discord.gg/sTzwBzDkK9). We can't wait to see what you do!
87+
Contributions are more than welcome!
88+
See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information.
8889

8990
## License
9091

0 commit comments

Comments
 (0)