YGGverse/Yo
1
0
Fork 0
mirror of https://github.com/YGGverse/Yo.git synced 2026-04-01 02:05:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
ghost 2023-11-24 20:03:12 +02:00
parent 17c6b1c48e
commit f70042263b
1 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -24,15 +24,16 @@ Default build inspired and adapted for [Yggdrasil](https://github.com/yggdrasil-
* MIME-based crawler with flexible filter settings * MIME-based crawler with flexible filter settings
* Page snap history with local and remote mirrors support * Page snap history with local and remote mirrors support
## Documentation
### Install ### Install
1. Install php and manticore 1. Install `composer`, `php` and `manticore`
2. Grab latest version `git clone https://github.com/YGGverse/Yo.git` 2. Grab latest version `git clone https://github.com/YGGverse/Yo.git`
3. Check `src/config.json` for any customizations 3. Run `composer update` inside the project directory
4. Run indexes init script `php src/cli/index/init.php` 4. Check `src/config.json` for any customizations
5. [Start crawling!](https://github.com/YGGverse/Yo#add) 5. Run indexes init script `php src/cli/index/init.php`
6. [Start crawling!](https://github.com/YGGverse/Yo#documentation)
## Documentation
### CLI ### CLI