Pārlūkot izejas kodu

update docs

tags/v1.4.12
Jonathan Cobb pirms 3 gadiem
vecāks
revīzija
d7ec1774d8
3 mainītis faili ar 36 papildinājumiem un 35 dzēšanām
  1. +2
    -16
      docs/dev.md
  2. +2
    -19
      docs/run-binary.md
  3. +32
    -0
      docs/system-software.md

+ 2
- 16
docs/dev.md Parādīt failu

@@ -9,24 +9,10 @@ Other Debian-based systems will probably also work fine.

See below for other Linux distributions and other operating systems.

## First-Time System Setup
## One-Time System Setup
You'll need to install some software for Bubble to work correctly.

After you clone this repository, run:

./bin/first_time_ubuntu.sh

This runs some `apt` commands to install various bits of software needed to run Bubble.

If you are running on a non-Ubuntu system, copy that file to something like:

./bin/first_time_myoperatingsystem.sh

And then edit it such that all the same packages get installed.
Then submit a pull request and we can add support for your operating system to the main repository.

You only need to run this command once, ever, on a development system.
It ensures that the appropriate packages are installed and proper databases and database users exist.
Follow the instructions in [System Software Setup](system-software.md) to install the required software.

## First-Time Dev Setup
After running the system setup above, run:


+ 2
- 19
docs/run-binary.md Parādīt failu

@@ -18,27 +18,10 @@ Change directories into the directory containing the files that were unzipped:

cd bubble-Adventure_1.x.x # replace `Adventure_1.x.x` with the version that you downloaded

## Install System Software
## One-Time System Setup
You'll need to install some software for Bubble to work correctly.

For Ubuntu systems, run:

./bin/first_time_ubuntu.sh

For Mac OS X systems, run:

./bin/first_time_macosx.sh

You only need to run this command once, ever, on a given system.
It ensures that the appropriate packages are installed and proper databases and database users exist.

If you are running a different OS or distribution, copy `first_time_ubuntu.sh` to something like:
./bin/first_time_myoperatingsystem.sh
Then edit it such that all the same packages get installed.

Submit a pull request, and we'll add support for your operating system to the main repository.
Follow the instructions in [System Software Setup](system-software.md) to install the required software.

## Run Bubble
Continue by running your Bubble as a [Local Launcher](local-launcher.md).

+ 32
- 0
docs/system-software.md Parādīt failu

@@ -0,0 +1,32 @@
# Install Required System Software
You only need to do this if you're running from a binary distribution or building and running from source.

If you're using the Bubble Docker Launcher, you can skip this step.

## Why Do This?
You'll need to install some software for Bubble to work correctly.

Bubble needs a PostgreSQL database, Redis, and a bunch of command line tools installed.

It ensures that the appropriate packages are installed and proper databases and database users exist.
You only need to install system software once, ever, on a given system.

### Ubuntu
For Ubuntu 18.04 and 20.04 systems, run:

./bin/first_time_ubuntu.sh

### Mac OS X
For Mac OS X systems, run:

./bin/first_time_macosx.sh

### Other Operating Systems
If you are running a different OS or distribution, copy `first_time_ubuntu.sh` to something like:
./bin/first_time_myoperatingsystem.sh
Then edit it such that all the same packages get installed.

Submit a pull request, and we'll add support for your operating system to the main repository.


Notiek ielāde…
Atcelt
Saglabāt