Merge pull request bitburner-official#6 from MSivonen/readme_for_dummies

Guide for dummies

README.md

@@ -1,15 +1,32 @@
-## Dependencies
+# Typescript template for Bitburner's Remote File API
 
-[Node.js](https://nodejs.org/en/download/) required for compiling typescript and installing dependencies
+The official template for synchronizing Typescript/Javascript from your computer to the game.
 
-## Installation
+[Step by step install](https://github.com/bitburner-official/typescript-template/guide_for_dummies.md)
 
+[Learn more about Typescript](https://www.typescriptlang.org/docs/)
+
+## About
+
+This template uses the Typescript compiler and the Remote File API system to synchronize Typescript to your game.
+Due to the usage of the RFA system, it works with Web and Electron versions of the game.
+
+## Prerequisites
+
+[Node.js](https://nodejs.org/en/download/) is needed for compiling typescript and installing dependencies
+
+[See here for step by step installation](https://github.com/bitburner-official/typescript-template/guide_for_dummies.md) if you'd like help with installing Node and/or connecting to the game.
+
+## Quick start
+
+Download the template to your computer and install everything it requires:
 ```
 git clone https://github.com/bitburner-official/typescript-template
+cd typescript-template
 npm i
 ```
 
-## How to use this template
+### How to use this template
 
 Write all your typescript source code in the `/src` directory
 
@@ -20,15 +37,18 @@ Have them both running simultaneously so that it all happens automatically.
 For Bitburner to receive any files, you need to enter the port `npm run watch` logs to the terminal
 in the Remote API section of the game settings, and press the connect button.
 
-## Imports
+[See here for step by step installation](https://github.com/bitburner-official/typescript-template/guide_for_dummies.md) if you'd like help with installing Node and/or connecting to the game.
+
+## Advanced
+### Imports
 
 To ensure both the game and typescript have no issues with import paths, your import statements should follow a few formatting rules:
 
 - Paths must be absolute from the root of `src/`, which will be equivalent to the root directory of your home drive
 - Paths must contain no leading slash
 - Paths must end with no file extension
 
-### Examples:
+#### Examples:
 
 To import `helperFunction` from the file `helpers.ts` located in the directory `src/lib/`:
 
@@ -48,6 +68,6 @@ To import `someFunction` from the file `main.ts` located in the `src/` directory
 import { someFunction } from "main";
 ```
 
-## Debugging
+### Debugging
 
 For debugging bitburner on Steam you will need to enable a remote debugging port. This can be done by rightclicking bitburner in your Steam library and selecting properties. There you need to add `--remote-debugging-port=9222` [Thanks @DarkMio]

guide_for_dummies.md

@@ -0,0 +1,60 @@
+# Step by step guide to setting up the Typescript template from scratch
+This guide is mostly focused on Windows users (Mac instructions are given at some places).
+If you're a Linux/Mac/Other user, there's an expectancy that you know your system and it's peculiarities compared to Windows.
+If you need help with your particular system, feel free to ask for help in the Official Bitburner Discord.
+
+### 1. Backup your savegame (just in case) 
+- Augmentations -> Backup save
+
+### 2. Install Node.js
+- Go to https://nodejs.org/en/  
+- Download the version that's recommended for most users.
+- Install it. Just click next, next, next, next, finish.
+
+### 3. Download this:
+- Go to https://github.com/bitburner-official/typescript-template  
+- Click the green 'Code' button
+- If you're unfamiliar with Git and have no intention to use it:
+  - Press the Download Zip button
+  - Extract the zip anywhere, for example `C:\Users\yourusername\Workspace\BitburnerScripts` on Windows or `~/Workspace/BitburnerScripts` on Other
+
+### 4. Start the Remote File API server
+- Open command prompt / terminal
+  - Windows: Open start menu and type `cmd` (enter)  
+  - Mac: Click the Launchpad icon in the Dock, type `Terminal` in the search field, then click Terminal.
+- To go to the directory you just created:  
+  - Windows: Type `cd ` and drag the folder you created to the cmd window, or type `cd C:\Users\yourusername\Workspace\BitburnerScripts` or whatever folder you chose previously.  
+  - Mac: Type `cd ` drag the folder you created to the terminal window, or type `cd ~/Workspace/BitburnerScripts` or whatever folder you chose previously. 
+
+- type `npm install`
+- type `npm run watch`
+- If NPM asks if you want to install something it needs, answer `y` for yes.
+- Your firewall may yell at you; allow the connection.
+
+### 5. Go back to Bitburner.
+- Options -> Remote API -> type in the port: `12525` -> click connect. The icon should turn green and say it's online.
+- Your firewall may yell at you again; allow the connection.
+
+### 6. Starting the Typescript transpiler
+- DON'T SKIP EVEN WHEN USING JS ONLY
+- Open another cmd/terminal window just like you did in step 4.
+- This time run the command `npm run transpile` in your folder.
+  Yes, you need them both to be running at the same time.
+- Put your .ts files to the `src\` directory.
+
+### 7. Test that the connection works
+- You should see a file `template.js` in the root of your `home` server in Bitburner.
+- You should see a NetscriptDefinitions.d.ts automatically appear in the folder on your computer (ex. `C:\Users\yourusername\Workspace\BitburnerScripts\NetscriptDefinitions.d.ts`).
+
+### 8. Try some other files too!
+- Copy/create a .js to the `src` folder on your computer and check Bitburner. The file should be transferred!
+- Sadly, at the time of writing, Typescript doesn't support 'compiling' text files. So copy/create a .txt in the `dist` folder and check Bitburner. This file should be transferred as well.
+
+
+### 9. Thats it!
+- You can now make and edit the files in the `src` directory to your liking, and have them be changed in Bitburner automatically.
+<br />
+<br />
+
+### For more information
+Read the readme of this https://github.com/bitburner-official/typescript-template and feel free to ask in Bitburner Discord channel `#external-editors:` https://discord.com/channels/415207508303544321/923428435618058311