Permalink
Browse files

Some doc changes

  • Loading branch information...
OtakuMegane committed Feb 5, 2019
1 parent dfb87f7 commit 0276f0adbcdc6aa04c140cef1936e297d0ec61bd
Showing with 12 additions and 11 deletions.
  1. +1 −1 INSTALL.md
  2. +3 −3 README.md
  3. +8 −7 documentation/DEV-GUIDE.md
@@ -11,5 +11,5 @@ For SQLite you just need the path to where you wish the database file to be stor
- Set `sqltype` to whichever type of database you are using. The current options are MYSQL, MARIADB, POSTGRESQL and SQLITE
- There is a configuration section for each type of SQL database. You only need to configure for the type of database you are using; the others can be left alone.
5. Go to `imgboard.php?install` in a browser and give it a moment to run the install routines. If anything goes wrong it should give a relevant error message.
6. If installation is successful you should receive a success message then be given a link to default home page. From there you can log in to create boards and further configure the script. You can also go to `imgboard.php?module=login` to access the login page.
6. If installation is successful you should receive a success message and a link to default home page. From there you can log in to create boards and further configure the script. You can also go to `imgboard.php?module=login` to access the login page.
7. Once you have logged in and confirmed things are working, go back to the `config.php` and set `defaultadmin` and `defaultadmin_pass` back to empty.
@@ -2,18 +2,18 @@
## About
A relatively lightweight, expandable and highly configurable imageboard written in PHP. Nelliel was originally a modified version of [Futallaby](https://www.1chan.net/futallaby/) made to host Nigrachan. The software had good potential and was split off to independent development. The codebase has since been fully rewritten and expanded, with continuing refinements. It does not try to do everything imaginable but instead provides a solid core that is readily expandable for users with additional needs.

**At present Nelliel should be considered early beta software. Use with caution. It is still incomplete and will have breaking changes.**
**At present Nelliel should be considered beta software. Use with caution. It is still incomplete and will have breaking changes.**

## Minimum Requirements
These are only the confirmed bare minimum requirements for Nelliel to function. Earlier versions may work but will likely be unstable and will not receive any support. **It is strongly recommended to use the latest software versions available.**
These are only the confirmed bare minimum requirements for Nelliel to function. Earlier versions may work but are likely to be unstable and will not receive any support. **It is strongly recommended to use the latest software versions available.**

Required:
- PHP 7.0+
- MySQL 5.6+, MariaDB 10+, PostgreSQL 9.4+ or SQLite 3.16+
- iconv
- PHP PDO with MySQL, MariaDB, PostgreSQL or SQLite support
- PHP GD
- PHP DOM
- iconv

In most cases these requirements will be fulfilled by a standard PHP install and everything will run out of the box. In the case a component is not present it will usually be available in the default system repos and can be easily installed.

@@ -1,8 +1,8 @@
# Nelliel Development Standards and Guideline

A guide to the development standards of Nelliel. Any contributions to the core codebase must follow these guidelines. Pull requests not adhering to the guidelines must be fixed before acceptance.
A guide to the development standards of Nelliel. Any contributions to the core codebase or official plugins must follow these guidelines. Pull requests not adhering to the guidelines must be fixed before acceptance.

Developers of mods, plugins or other unofficial contributions are encouraged to follow this guide but it is not mandatory.
Developers of mods, plugins or other unofficial contributions are not required to follow this guide.

## Coding Style and Formatting
Nelliel follows the [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-4](http://www.php-fig.org/psr/psr-4/) standards.
@@ -13,6 +13,7 @@ In addition:
- 4-space indentation for code; tabs are used for indentation of HTML.
- Single quotes `' '` should be used for strings when practical.
- No `?>` closing tags.
- Constants should be ALL CAPS.

## Functions, Classes and Structure
- Procedural is not evil. OOP is not the Holy Grail. Use what makes sense for a given situation.
@@ -30,7 +31,7 @@ Query requirements:
- All identifiers should be treated as case sensitive.
- Non-parameterized string literals must be placed inside single quotes `' '`.
- SQL keywords should be ALL CAPS.
- Database NULL is treated as unknown value.
- Database NULL should be treated as unknown value.

## Targets and Version Support
Any stable core functions and features contributed to Nelliel must be fully functional with the minimum versions listed below in addition to all later versions of the software. These minimum requirements will change over time due to certain circumstances including (but not limited to):
@@ -43,10 +44,10 @@ At present Nelliel has a target version of **PHP 7.0**.

### Database Support
Minimum supported RDBMS versions:
- MySQL 5.6.39
- MariaDB 10.0.33
- PostgreSQL 9.4.14
- SQLite 3.16.0
- MySQL 5.6
- MariaDB 10.0
- PostgreSQL 9.4
- SQLite 3.16

### Browser Support
These are the minimum browser versions Nelliel must be compatible with:

0 comments on commit 0276f0a

Please sign in to comment.