3wordchant
/
oasis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Simplify installation 

Problem: The install instructions in the readme contains quotes because
it has a `*`, but `#semver:` does what we need without the quotes. The
`docs/install.md` file also has some unnecessary complexity, like
cloning via SSH (only useful for maintainers), which I think we can
safely remove.

Solution: Change the install instruction and reorganize
`docs/install.md` to be more relevant to people who are installing from
source.
This commit is contained in:
Christian Bundy 2020-02-29 08:31:07 -08:00
parent 3c1453db33
commit 3758bbf636
3 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.cspell.json
View File

@ -3,6 +3,7 @@
"language": "en",
"words": [
"AGPL",
"EACCESS",
"Argyris",
"Hintjens",
"Kata",

4
README.md
View File

@ -77,13 +77,13 @@ Most people should install stable releases with [npm](https://npmjs.org/) and
Node.js [**current** or **active LTS** release](https://nodejs.org/en/about/releases/).
```shell
npm --global install 'fraction/oasis#semver:*'
npm -g install fraction/oasis#semver:
```
For faster updates and less stability, install from GitHub and upgrade often.
```shell
npm --global install fraction/oasis
npm -g install fraction/oasis
```
Want more? Check out [`install.md`](https://github.com/fraction/oasis/blob/master/docs/install.md).

33
docs/install.md
View File

@ -12,40 +12,35 @@ If you want to run Oasis on Android via Termux, see [`with-termux.md`](./with-te
## Download
### HTTPS
Most people should download Oasis over HTTPS.
Download Oasis from GitHub over HTTPS.
```shell
git clone https://github.com/fraction/oasis.git
```
### SSH
If you already have SSH, you may prefer to download over SSH instead.
```shell
git clone git@github.com:fraction/oasis.git
```
## Install
## Install dependencies
Most people should build and install Oasis with npm.
```shell
cd oasis
npm install
npm --global install .
npm install --only=prod
```
## Start
You did it! Oasis should now be installed.
You can try Oasis without installing with:
```shell
oasis --help
node .
```
If you have problems, read the documentation on [downloading and installing
packages globally](https://docs.npmjs.com/downloading-and-installing-packages-globally)
or [get some help](https://github.com/fraction/oasis/issues/new/choose).
## Install globally
If you want to install to make `oasis` available globally:
```shell
npm -g install .
```
If you see a permission error, see [resolving EACCESS permission errors](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). If you any other problems, please [reach out for help](https://github.com/fraction/oasis/issues/new).