Improve readability of README

main
Alt 2 years ago committed by GitHub
parent fec1622b2e
commit be966faf36
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,16 +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
```
- Click [here](https://github.com/bitburner-official/typescript-template/guide_for_dummies.md) for step by step installation if you haven't used node.js before
## How to use this template
### How to use this template
Write all your typescript source code in the `/src` directory
@ -21,7 +37,10 @@ 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:
@ -29,7 +48,7 @@ To ensure both the game and typescript have no issues with import paths, your im
- 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/`:
@ -49,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]

Loading…
Cancel
Save