Convert READMEs to lightly formatted markdown, so they display nicely on Github etc.

This commit is contained in:
Dave Page
2021-02-05 16:18:50 +00:00
parent 5d098fe4b0
commit 530eb3972b
10 changed files with 497 additions and 508 deletions

View File

@@ -1,35 +0,0 @@
Building pgAdmin4.dmg on macOS
==============================
Required Packages (Either build the sources or get them from macports or
similar):
1. Yarn & NodeJS
2. PostgreSQL installation
- PostgreSQL 12 or above from http://www.postgresql.org/
3. Python 3.5+ (required for building). The build environment should run this
version of python in response to the "python" command.
Building:
1. To bundle a different version of Python from the default of 3.9.0, set the
PGADMIN_PYTHON_VERSION environment variable, e.g:
export PGADMIN_PYTHON_VERSION=3.8.5
2. If a path different from the default of /usr/local/pgsql for the PostgreSQL
installation has been used, set the PGADMIN_POSTGRES_DIR environment variable
appropriately, e.g:
export PGADMIN_POSTGRES_DIR=/opt/local/pgsql
3. If you want to codesign the appbundle, copy codesign.conf.in to
codesign.conf and set the values accordingly.
4. To build, go to pgAdmin4 source root directory and execute "make appbundle".
This will create the python virtual environment and install all the required
python modules mentioned in the requirements file using pip, build the
runtime code and finally create the app bundle and the DMG in ./dist
directory.

41
pkg/mac/README.md Normal file
View File

@@ -0,0 +1,41 @@
# pgAdmin macOS Builds
## Required Packages
Either build the sources or get them from macports or similar:
1. Yarn & NodeJS
2. PostgreSQL 12 or above from http://www.postgresql.org/
3. Python 3.6+ (required for building). The build environment should run this
version of python in response to the *python* command.
## Building
1. To bundle a different version of Python from the default of 3.9.0, set the
*PGADMIN_PYTHON_VERSION* environment variable, e.g:
export PGADMIN_PYTHON_VERSION=3.8.5
2. If a path different from the default of /usr/local/pgsql for the PostgreSQL
installation has been used, set the *PGADMIN_POSTGRES_DIR* environment variable
appropriately, e.g:
export PGADMIN_POSTGRES_DIR=/opt/local/pgsql
3. If you want to codesign the appbundle, copy *codesign.conf.in* to
*codesign.conf* and set the values accordingly.
3. If you want to notarize the appbundle, copy *notarization.conf.in* to
*notarization.conf* and set the values accordingly. Note that notarization
will fail if the code isn't signed.
4. To build, go to pgAdmin4 source root directory and execute:
make appbundle
This will create the python virtual environment and install all the required
python modules mentioned in the requirements file using pip, build the
runtime code and finally create the app bundle and the DMG in *./dist*
directory.