mirror of
https://gitea.invidious.io/iv-org/invidious-copy-2023-06-08.git
synced 2024-08-15 00:53:38 +00:00
Update README
This commit is contained in:
parent
d9c89f7e3f
commit
a7d223a0cf
1 changed files with 13 additions and 8 deletions
21
README.md
21
README.md
|
@ -1,18 +1,20 @@
|
|||
# Invidious
|
||||
|
||||
> Invidious is a web application that indexes popular video sites
|
||||
> Invidious is what YouTube should be
|
||||
|
||||
## Installation
|
||||
|
||||
### Installing [Crystal](https://github.com/crystal-lang/crystal):
|
||||
|
||||
On Arch:
|
||||
|
||||
```bash
|
||||
$ sudo pacman -Syu shards crystal
|
||||
$ crystal deps
|
||||
```
|
||||
|
||||
On OSX:
|
||||
|
||||
```bash
|
||||
$ brew update
|
||||
$ brew install shards crystal-lang
|
||||
|
@ -25,11 +27,13 @@ On Arch:
|
|||
Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL):
|
||||
|
||||
On OSX:
|
||||
|
||||
```bash
|
||||
$ brew install postgres
|
||||
```
|
||||
|
||||
Then setup database with:
|
||||
Then setup database with
|
||||
|
||||
```bash
|
||||
$ ./setup.sh
|
||||
```
|
||||
|
@ -41,6 +45,7 @@ $ crystal src/invidious.cr
|
|||
```
|
||||
|
||||
Or for development:
|
||||
|
||||
```bash
|
||||
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
|
||||
$ ./sentry
|
||||
|
@ -48,12 +53,12 @@ $ ./sentry
|
|||
|
||||
## Contributing
|
||||
|
||||
1. Fork it ( https://github.com/omarroth/invidious/fork )
|
||||
2. Create your feature branch (git checkout -b my-new-feature)
|
||||
3. Commit your changes (git commit -am 'Add some feature')
|
||||
4. Push to the branch (git push origin my-new-feature)
|
||||
5. Create a new Pull Request
|
||||
1. Fork it ( https://github.com/omarroth/invidious/fork )
|
||||
2. Create your feature branch (git checkout -b my-new-feature)
|
||||
3. Commit your changes (git commit -am 'Add some feature')
|
||||
4. Push to the branch (git push origin my-new-feature)
|
||||
5. Create a new Pull Request
|
||||
|
||||
## Contributors
|
||||
|
||||
- [omarroth](https://github.com/omarroth) - creator, maintainer
|
||||
* [omarroth](https://github.com/omarroth) - creator, maintainer
|
||||
|
|
Loading…
Reference in a new issue