Added Windows info

This commit is contained in:
Jason Windisch 2018-03-24 00:57:32 -04:00
parent b1423fdb10
commit 0e15c2f9a6
3 changed files with 89 additions and 28 deletions

View File

@ -1,32 +1,11 @@
---
layout: page
title: OS & Hardware Specific Information
title: OS/Hardware Specific
---
## Raspberry Pi
There are multiple ways of installing ENiGMA BBS, depending on your level of experience and desire to do
things manually versus have it automated for you.
All Raspberry Pi models work great with ENiGMA½! Keep in mind compiling the dependencies with
`npm install` will take some time and *may* appear to hang. It's still working - just be patient and let it
complete.
### Basic Instructions
1. Download [Raspbian Stretch Lite](https://www.raspberrypi.org/downloads/raspbian/). Follow the instructions
on the [Raspbian site](https://www.raspberrypi.org/documentation/installation/installing-images/README.md) regarding how
to get it written to an SD card.
2. Run `sudo raspi-config`, then:
1. Set your timezone (option 4, option I2)
2. Enable SSH (option 5, option P2)
3. Expand the filesystem to use the entire SD card (option 7, option A1)
3. Update & upgrade all packages: `apt-get update && apt-get upgrade`
4. Install required packages: `sudo apt install lrzsz p7zip-full`
5. Follow the [installation instructions](/installation) to install ENiGMA½.
6. Profit!
## Windows
Needs more info, please submit a PR!
| Method | Operating System Compatibility | Notes |
|----------------------------------------|------------------------------------------------|---------------------------------------------------------------------------------------------|
| [Raspberry Pi](rpi) | Linux, BSD, OSX | All Raspberry Pi models work great with ENiGMA½! |
| [Windows](windows) | Windows | Easy upgrades, compatible with all operating systems, no dependencies to install |

32
docs/installation/rpi.md Normal file
View File

@ -0,0 +1,32 @@
---
layout: page
title: OS & Hardware Specific Information
---
## Raspberry Pi
All Raspberry Pi models work great with ENiGMA½! Keep in mind compiling the dependencies with
`npm install` will take some time and *may* appear to hang. It's still working - just be patient and let it
complete.
### Basic Instructions
1. Download [Raspbian Stretch Lite](https://www.raspberrypi.org/downloads/raspbian/). Follow the instructions
on the [Raspbian site](https://www.raspberrypi.org/documentation/installation/installing-images/README.md) regarding how
to get it written to an SD card.
2. Run `sudo raspi-config`, then:
1. Set your timezone (option 4, option I2)
2. Enable SSH (option 5, option P2)
3. Expand the filesystem to use the entire SD card (option 7, option A1)
3. Update & upgrade all packages: `apt-get update && apt-get upgrade`
4. Install required packages: `sudo apt install lrzsz p7zip-full`
5. Follow the [installation instructions](/installation) to install ENiGMA½.
6. Profit!
## Windows
Needs more info, please submit a PR!

View File

@ -0,0 +1,50 @@
---
layout: page
title: Windows Full Install
---
## Windows
ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doors naively then you should use a 32 bit Windows.
### Basic Instructions
1. Download and Install [Node.JS](https://nodejs.org/en/download/).
1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method.
`Run PowerShell as Administrator
Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force
npm install -g npm-windows-upgrade
npm-windows-upgrade`
Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward.
Also if you run the NodeJS installer, it will replace the node version.:
2. Install [windows-build-tools for npm] (https://www.npmjs.com/package/windows-build-tools)
'npm install --global --production windows-build-tools'
*This will also install python 2.7
2. Install [7zip] (https://www.7-zip.org/download.html).
*Add 7zip to your path so 7z can be called from the console
3. Install [Git] (https://git-scm.com/downloads) and optionally [TortoiseGit] (https://tortoisegit.org/download/).
4. Clone Enigma - browse to the directory you want and run "git clone https://github.com/NuSkooler/enigma-bbs.git"
Optionally use the tortoisegit gui by right clicking the directory and run git clone in the menu
5. Install ENiGMA½.
1. In the enigma directory run 'npm install'
2. Generate your initial configuration:
'node .\oputil.js config new'
Follow the prompts!
3. Edit any configuration files
4. Run ENiGMA½
'node .\main.js'
6. Profit!