Removed git installation method since it is only for framework developers and already mentioned under contributing section.

This commit is contained in:
Lonnie Ezell 2020-04-28 22:39:45 -05:00
parent 0746941df3
commit f97426e1fe
No known key found for this signature in database
GPG Key ID: 71836D6EF250F1D1
3 changed files with 12 additions and 86 deletions

View File

@ -92,3 +92,11 @@ If you are using the command-line, you can do the following to update your fork
3. `git push origin develop`
Your fork is now up to date. This should be done regularly and, at the least, before you submit a pull request.
## Translations Installation
If you wish to contribute to the system message translations,
then fork and clone the [translations repository](https://github.com/codeigniter4/translations>)
separately from the codebase.
These are two independent repositories!

View File

@ -4,28 +4,25 @@ Installation
CodeIgniter4 can be installed in a number of different ways: manually,
using `Composer <https://getcomposer.org>`_, or using
`Git <https://git-scm.com/>`_.
`Git <https://git-scm.com/>`_.
Which is right for you?
- If you would like the simple "download & go" install that CodeIgniter3
is known for, choose the manual installation.
- If you plan to add third party packages to your project, we
recommend the Composer installation.
- If you are thinking of contributing to the framework,
then the Git installation is right for you.
- If you plan to add third party packages to your project, or want to keep
CodeIgniter up to date easily, we recommend the Composer installation.
.. toctree::
:titlesonly:
installing_manual
installing_composer
installing_git
running
upgrading
troubleshooting
repositories
However you choose to install and run CodeIgniter4, the
However you choose to install and run CodeIgniter4, the
`user guide <https://codeigniter4.github.io/userguide/>`_ is accessible online.
.. note:: Before using CodeIgniter 4, make sure that your server meets the

View File

@ -1,79 +0,0 @@
Git Installation
###############################################################################
This would *not* be suitable for app development, but *is* suitable
for contributing to the framework.
Installation
-------------------------------------------------------
Install the latest version of the codebase by
- forking the `codebase <https://github.com/codeigniter4/CodeIgniter4>`_ to your github account
- cloning **your** forked repository locally
Setting Up
-------------------------------------------------------
You will want to set up a remote repository alias, so you can synchronize
your repository with the main one::
git remote add upstream https://github.com/codeigniter4/CodeIgniter4.git
Copy the provided ``env`` file to ``.env``, and use that for your git-ignored configuration settings,
Copy the provided ``phpunit.xml.dist`` to ``phpunit.xml`` and tailor it as needed,
if you want custom unit testing for the framework.
Upgrading
-------------------------------------------------------
Update your code anytime::
git checkout develop
git pull upstream develop
git push origin develop
Merge conflicts may arise when you pull from "upstream".
You will need to resolve them locally.
Pros
-------------------------------------------------------
- You have the latest version of the codebase (unreleased)
- You can propose contributions to the framework, by creating a
feature branch and submitting a pull request for it to the main repo
- A pre-commit hook is installed for your repo, that binds it to the
coding-standard we use
Cons
-------------------------------------------------------
- You need to resolve merge conflicts when you synch with the repo.
- You would not use this technique for app development.
Structure
-------------------------------------------------------
Folders in your project after set up:
- app, public, system, tests, user_guide_src, writable
Translations Installation
============================================================
If you wish to contribute to the system message translations,
then fork and clone the `translations repository
<https://github.com/codeigniter4/translations>`_ separately from the codebase.
These are two independent repositories!
Coding Standards Installation
============================================================
This is bound and installed automatically as part of the
codebase installation.
If you wish to use it inside your project too,
``composer require codeigniter4/translations @beta``