diff --git a/README.md b/README.md index c8b4f39..4c7e0bf 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,20 @@ NovaconiumPHP is a high-performance PHP framework designed with inspiration from Pronounced: Noh-vah-koh-nee-um -Packagist: https://packagist.org/packages/4lt/novaconium -Master Repo: https://git.4lt.ca/4lt/novaconium +* Packagist: https://packagist.org/packages/4lt/novaconium +* Master Repo: https://git.4lt.ca/4lt/novaconium ## Getting Started -Novaconium is heavly influenced by docker, but you can use composer outside of docker. -You can [learn more about how novaconium works with composer](https://git.4lt.ca/4lt/novaconium/src/branch/master/docs/Install-Composer-On-Debian.md). +Novaconium is designed to be developed primarily using Docker. Instead of relying on tools installed directly on your system, common development tasks are executed inside containers: + +* Composer runs inside a Docker container rather than on your host machine +* Apache / PHP are served from containers instead of your local environment +* Sass compilation is also handled within a container + +As long as you have Docker installed, you can use the full development environment without installing additional dependencies on your system. + +You can [learn more about how novaconium works with composer](https://git.4lt.ca/4lt/novaconium/src/branch/master/docs/Composer.md). ```bash PROJECTNAME=novaproject; diff --git a/docs/Composer.md b/docs/Composer.md index 4bbea55..bf4abe8 100644 --- a/docs/Composer.md +++ b/docs/Composer.md @@ -8,7 +8,7 @@ Update novaconium with composer in docker: ```docker run --rm --interactive --tt ## Install Composer natively on Debian -Assuming you have nala installed: +Assuming you have nala installed (otherwise use apt-get): ```bash sudo nala install curl php-cli php-mbstring git unzip