Skip to content

Commit

Permalink
Improve files under docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
itismadness committed Aug 21, 2021
1 parent 7c72614 commit 2268ad4
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 612 deletions.
11 changes: 7 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ lint-css:
yarn lint:css
yarn lint:css-checkstyle

.PHONY: lint-php
lint-php:
yarn lint:php:internal
yarn lint:php:phpcs || exit 0
composer phpstan

.PHONY: mysqldump
mysqldump:
mysqldump -h 127.0.0.1 -P 36000 -u gazelle --password=password -d gazelle --skip-add-drop-table --skip-add-locks --single-transaction | sed 's/ AUTO_INCREMENT=[0-9]*//g' > db/data/gazelle.sql
Expand All @@ -59,10 +65,7 @@ ocelot-reload-reload:
pkill -USR1 ocelot

.PHONY: test
test: lint-css
yarn lint:php:internal
yarn lint:php:phpcs || exit 0
composer phpstan
test: lint-css lint-php
composer test

.PHONY: twig-flush
Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ needs. Gazelle is written in PHP, JavaScript, and MySQL.

## Gazelle Runtime Dependencies
* [Nginx](http://wiki.nginx.org/Main) (recommended)
* [PHP 7 or newer](https://www.php.net/) (required)
* [PHP 7.2+](https://www.php.net/) (required)
* [NodeJS 12+](https://nodejs.org/en/) (required)
* [Memcached](http://memcached.org/) (required)
* [Sphinx 2.0.6 or newer](http://sphinxsearch.com/) (required)
* [procps-ng](http://sourceforge.net/projects/procps-ng/) (recommended)
* ocelot
* [ocelot](https://github.com/OPSnet/Ocelot)

_Note: This list may not be exhaustive._

Expand All @@ -20,13 +21,22 @@ depedencies through `pip`:
* eac-logchecker
* xld-logchecker

## Installation

We provide installation notes [here](docs/INSTALL.txt). These notes are provided as a best effort, and are not guaranteed
to be fully up-to-date or accurate.

Due to the nature of torrenting, we HIGHLY recommend not trying to run this in production if you are not prepared or knowledgeable
in setting up servers, proxies, and tuning TCP configs to get proper performance and privacy.

## Gazelle Development
Docker is used to develop Gazelle. See https://docs.docker.com/engine/install/
for more information on getting Docker set up locally.

Setup the ocelot container, by cloning it and running:
Setup the [ocelot](https://github.com/OPSnet/Ocelot) container image, by doing the following:

```bash
git clone https://github.com/OPSnet/ocelot
docker build . -t ocelot
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
From: Spine
To: Developers
Date: 2020-03-30
Subject: Orpheus Development Papers #6 - HTML Official Colors
Version: 1

List of valid colors to be used [color] BBCode tag. This should match the list of
colors defined in the Text::$ColorName constant.

aliceblue
antiquewhite
aqua
Expand Down
Loading

0 comments on commit 2268ad4

Please sign in to comment.