Skip to content

Commit

Permalink
readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
resucutie committed Dec 29, 2023
1 parent 4d5fb36 commit 8c6ce91
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<p align="center"><img src="icon.svg"/></p>
<h1 align="center">Beyond Software</h1>
<p align="center">
A collective list of reliable and trustworthy software and resources for a better user expierence.<br>
Not influenced by sponsors, advertisements or finnancial gain.
</p>

<br>

# How to Contribute
- Adding an issue requesting a new entry
- (preferred) Make a Pull Request

Check the guidelines first [avaiable on the webpage](https://beyondsoftware.info/#guidelines) or [directly at the file](/public/assets/index.md#guidelines).
The whole list of software is avaiable at [/public/assets/index.md](/public/assets/index.md).

**Please delete your forks after merging with the main repo. This is to prevent outdated information to be out in the wild**

# Running for dev/production enviorment
## Installing
1. Download [Git](https://git-scm.com/) and [Node](https://nodejs.org/)
2. `git clone https://github.com/abUwUser/beyond-software.git`
3. `cd beyond-software`
4. `npm i --global pnpm`
5. `pnpm i`
6. `git clone https://github.com/abUwUser/beyond-software-list.git ./docs`

## Building
Run `pnpm build` in the project folder to build the file. Sadly at the moment we do not provide any official way to watch for changes

For previewing, run `pnpm view-build`
42 changes: 42 additions & 0 deletions icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c6ce91

Please sign in to comment.